gn: Document gen's --check flag.
BUG=698539
Review-Url: https://codereview.chromium.org/2872453003
Cr-Original-Commit-Position: refs/heads/master@{#470042}
Cr-Mirrored-From: https://chromium.googlesource.com/chromium/src
Cr-Mirrored-Commit: 25e109413ae504e8b7aaf942169fa70d28fde6ed
diff --git a/tools/gn/command_gen.cc b/tools/gn/command_gen.cc
index 194cace..b2ced8f 100644
--- a/tools/gn/command_gen.cc
+++ b/tools/gn/command_gen.cc
@@ -274,7 +274,7 @@
const char kGen_Help[] =
R"(gn gen: Generate ninja files.
- gn gen [<ide options>] <out_dir>
+ gn gen [--check] [<ide options>] <out_dir>
Generates ninja files from the current tree and puts them in the given output
directory.
@@ -284,6 +284,9 @@
Or it can be a directory relative to the current directory such as:
out/foo
+ "gn gen --check" is the same as running "gn check". See "gn help check"
+ for documentation on that mode.
+
See "gn help switches" for the common command-line switches.
IDE options
@@ -353,9 +356,10 @@
Generic JSON Output
- Dumps target information to JSON file and optionally invokes python script on
- generated file. See comments at the beginning of json_project_writer.cc and
- desc_builder.cc for overview of JSON file format.
+ Dumps target information to a JSON file and optionally invokes a
+ python script on the generated file. See the comments at the beginning
+ of json_project_writer.cc and desc_builder.cc for an overview of the JSON
+ file format.
--json-file-name=<json_file_name>
Overrides default file name (project.json) of generated JSON file.
