summaryrefslogtreecommitdiff
path: root/docs/tidy.md
diff options
context:
space:
mode:
author Chih-Hung Hsieh <chh@google.com> 2022-02-17 12:54:45 -0800
committer Chih-Hung Hsieh <chh@google.com> 2022-02-17 14:48:40 -0800
commit9db8a0c5b28d3183f144bc94c3e0b1d5a522badd (patch)
tree57e235f14ae93104c604073e93b9265ea81bac5f /docs/tidy.md
parent70387c5d0350ee5e064c3a9dd92eb5600f0d08a4 (diff)
Add tidy_timeout_srcs property
Similar to `tidy_disabled_srcs`, a `tidy_timeout_srcs` list can be used to include all source files that took long to compile with clang-tidy. Files listed in `tidy_timeout_srcs` will not be compiled by clang-tidy when `TIDY_TIMEOUT` is defined. Bug: 201099167 Test: TIDY_TIME=90 make droid tidy-soong_subset Change-Id: Ie0bfda66caae4445d10117ceefa1b5b8c1ecf256
Diffstat (limited to 'docs/tidy.md')
-rw-r--r--docs/tidy.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/tidy.md b/docs/tidy.md
index 3140198c3..890c3a036 100644
--- a/docs/tidy.md
+++ b/docs/tidy.md
@@ -225,6 +225,16 @@ This 90-second limit is actually the default time limit
in several Android continuous builds where `WITH_TIDY=1` and
`CLANG_ANALYZER_CHECKS=1` are set.
+Similar to `tidy_disabled_srcs` a `tidy_timeout_srcs` list
+can be used to include all source files that took too much time to compile
+with clang-tidy. Files listed in `tidy_timeout_srcs` will not
+be compiled by clang-tidy when `TIDY_TIMEOUT` is defined.
+This can save global build time, when it is necessary to set some
+time limit globally to finish in an acceptable time.
+For developers who want to find all clang-tidy warnings and
+are willing to spend more time on all files in a project,
+they should not define `TIDY_TIMEOUT` and build only the wanted project directories.
+
## Capabilities for Android.bp and Android.mk
Some of the previously mentioned features are defined only