diff --git a/docs/user_doc.md b/docs/user_doc.md index 18724e1..2bfb41a 100644 --- a/docs/user_doc.md +++ b/docs/user_doc.md @@ -9,6 +9,7 @@ The *checks* comprise of these steps: 1. Run Cmake -- see [run_cmake.sh](https://github.com/google/llvm-premerge-checks/blob/master/scripts/run_cmake.sh#L31) for details 1. Build the binaries -- `ninja all` 1. Run the test suite -- `ninja check-all` +1. Run clang-format and clang-tidy on the diff. The checks are executed on one platform (Debian Testing on amd64 with the clang-8 tool chain) at the moment. The plan is to add more platforms, in the future. @@ -24,6 +25,8 @@ If you find any problems please raise an [issue on github](https://github.com/go To sign up for the pre-merge beta testing, please add yourself to the ["pre-merge beta testing" project](https://reviews.llvm.org/project/members/78/) on Phabricator. +The checks are enabled for all changes to `clang-tools-extra/clangd`. + # Requirements To get a patch on Phabricator tested - once you are signed up - the build server must be able to apply the patch to the checked out git repository. If you want to get your patch tested, please make sure that that either: