Tweaking documentation about check_targets and gn check Make it easier to understand how to check all the code, also code not listed in check_targets. Change-Id: Iaf572a9b7db6f38ed74259cb18f125dfd28cb66d Reviewed-on: https://gn-review.googlesource.com/c/3120 Reviewed-by: Brett Wilson <brettw@chromium.org> Commit-Queue: Brett Wilson <brettw@google.com>
diff --git a/docs/reference.md b/docs/reference.md index 277b3d8..a01c620 100644 --- a/docs/reference.md +++ b/docs/reference.md
@@ -5678,7 +5678,8 @@ check_targets [optional] A list of labels and label patterns that should be checked when running "gn check" or "gn gen --check". If unspecified, all targets will be - checked. If it is the empty list, no targets will be checked. + checked. If it is the empty list, no targets will be checked. To bypass + this list, request an explicit check of targets, for instance "//*". The format of this list is identical to that of "visibility" so see "gn help visibility" for examples.
diff --git a/tools/gn/command_check.cc b/tools/gn/command_check.cc index 99fbff5..9d9dcbd 100644 --- a/tools/gn/command_check.cc +++ b/tools/gn/command_check.cc
@@ -76,9 +76,9 @@ What gets checked - The .gn file may specify a list of targets to be checked. Only these targets - will be checked if no label_pattern is specified on the command line. - Otherwise, the command-line list is used instead. See "gn help dotfile". + The .gn file may specify a list of targets to be checked in the list + check_targets (see "gn help dotfile"). If a label pattern is specified + on the command line, check_targets is not used. Targets can opt-out from checking with "check_includes = false" (see "gn help check_includes").
diff --git a/tools/gn/setup.cc b/tools/gn/setup.cc index 94f5d79..060f17f 100644 --- a/tools/gn/setup.cc +++ b/tools/gn/setup.cc
@@ -71,7 +71,8 @@ check_targets [optional] A list of labels and label patterns that should be checked when running "gn check" or "gn gen --check". If unspecified, all targets will be - checked. If it is the empty list, no targets will be checked. + checked. If it is the empty list, no targets will be checked. To + bypass this list, request an explicit check of targets, like "//*". The format of this list is identical to that of "visibility" so see "gn help visibility" for examples.