clang_tidy.md: add info about --tidy_checks=...
This flag was added a bit ago, and helps a lot with evaluating new clang-tidy checks. Not only does it cut down on noise in the JSON summary file, but it can substantially speed up clang-tidy, since some checks are more expensive than others. Bug: None Change-Id: I68836205793defc76648fc977e45172f17ecace3 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3834505 Auto-Submit: George Burgess <gbiv@chromium.org> Commit-Queue: Quinten Yearsley <qyearsley@chromium.org> Reviewed-by: Quinten Yearsley <qyearsley@chromium.org> Cr-Commit-Position: refs/heads/main@{#1037534}
This commit is contained in:

committed by
Chromium LUCI CQ

parent
741ae6becc
commit
1b74018586
@ -94,8 +94,19 @@ format of this file is detailed in `tricium_clang_tidy_script.py`.
|
||||
|
||||
**Note** that the above command will use Chromium's top-level `.clang-tidy` file
|
||||
(or `.clang-tidy` files scattered throughout `third_party/`, depending on the
|
||||
files we lint. In order to test a *new* check, you'll have to add it to
|
||||
Chromium's top-level `.clang-tidy` file.
|
||||
files we lint. In order to test a *new* check, it's recommended that you use
|
||||
`tricium_clang_tidy_script.py`'s `--tidy_checks` flag. Usage of this looks like:
|
||||
|
||||
```
|
||||
$ cd ${chromium}/src
|
||||
$ ${chromium_build}/recipes/recipe_modules/tricium_clang_tidy/resources/tricium_clang_tidy_script.py \
|
||||
--base_path $PWD \
|
||||
--out_dir out/Linux \
|
||||
--findings_file all_findings.json \
|
||||
--clang_tidy_binary $PWD/third_party/llvm-build/Release+Asserts/bin/clang-tidy \
|
||||
--tidy_checks '-*,YOUR-NEW-CHECK-NAME-HERE'
|
||||
--all
|
||||
```
|
||||
|
||||
### Ignoring a check
|
||||
|
||||
|
Reference in New Issue
Block a user