StrixOS/build_soong
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Add ALLOW_LOCAL_TIDY_TRUE" am: e7410d933a

Browse Source 
Original change: https://android-review.googlesource.com/c/platform/build/soong/+/2089043

Change-Id: Ie449de57e691229ff97e8e5f540045a2f21c6dbd
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
This commit is contained in:
Chih-hung Hsieh
2022-05-07 00:10:36 +00:00
committed by Automerger Merge Worker
parent d2878482eb e7410d933a
commit 44be23964a
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/tidy.md
View File

@@ -31,7 +31,7 @@ The default global clang-tidy checks and flags are defined in
The global default can be overwritten by module properties in Android.bp.
### `tidy` and `tidy_checks`
### `tidy`, `tidy_checks`, and `ALLOW_LOCAL_TIDY_TRUE`
For example, in
[system/bpf/Android.bp](https://android.googlesource.com/platform/system/bpf/+/refs/heads/master/Android.bp),
@@ -52,8 +52,16 @@ cc_defaults {
}
```
That means in normal builds, even without `WITH_TIDY=1`,
the modules that use `bpf_defaults` will run clang-tidy
the modules that use `bpf_defaults` _should_ run clang-tidy
over C/C++ source files with the given `tidy_checks`.
However since clang-tidy warnings and its runtime cost might
not be wanted by all people, the default is to ignore the
`tidy:true` property unless the environment variable
`ALLOW_LOCAL_TIDY_TRUE` is set to true or 1.
To run clang-tidy on all modules that should be tested with clang-tidy,
`ALLOW_LOCAL_TIDY_TRUE` or `WITH_TIDY` should be set to true or 1.
Note that `clang-analyzer-security*` is included in `tidy_checks`
but not all `clang-analyzer-*` checks. Check `cert-err34-c` is
disabled, although `cert-*` is selected.
@@ -80,6 +88,9 @@ cc_test_library {
}
```
Note that `tidy:false` always disables clang-tidy, no matter
`ALLOW_LOCAL_TIDY_TRUE` is set or not.
### `tidy_checks_as_errors`
The global tidy checks are enabled as warnings.