| Index: tools/gn/docs/reference.md
|
| diff --git a/tools/gn/docs/reference.md b/tools/gn/docs/reference.md
|
| index 735e5f9eadd9afeba60a98dd64826e7044cdb72d..c5646681fb51cfed615983b72edcfed29d512cb4 100644
|
| --- a/tools/gn/docs/reference.md
|
| +++ b/tools/gn/docs/reference.md
|
| @@ -96,7 +96,7 @@
|
| * [code_signing_sources: [file list] Sources for code signing step.](#code_signing_sources)
|
| * [complete_static_lib: [boolean] Links all deps into a static library.](#complete_static_lib)
|
| * [configs: [label list] Configs applying to this target or config.](#configs)
|
| - * [console: [boolean] Run this action in the console pool.](#console)
|
| + * [console: [boolean] Use console pool for the pool object.](#console)
|
| * [data: [file list] Runtime data file dependencies.](#data)
|
| * [data_deps: [label list] Non-linked dependencies.](#data_deps)
|
| * [defines: [string list] C preprocessor defines.](#defines)
|
| @@ -598,7 +598,7 @@
|
| ### <a name="gen:"></a>**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.
|
| @@ -608,6 +608,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.
|
| ```
|
|
|
| @@ -688,9 +691,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.
|
| @@ -2138,13 +2142,16 @@
|
| context of more than one toolchain it is recommended to specify an
|
| explicit toolchain when defining and referencing a pool.
|
|
|
| + A pool marked "console = true" will use the built-in ninja "console"
|
| + pool and cannot specify "depth" which is always 1.
|
| +
|
| A pool is referenced by its label just like a target.
|
| ```
|
|
|
| #### **Variables**
|
|
|
| ```
|
| - depth*
|
| + console, depth*
|
| * = required
|
| ```
|
|
|
| @@ -2686,6 +2693,7 @@
|
| Other tools:
|
| "stamp": Tool for creating stamp files
|
| "copy": Tool to copy files.
|
| + "action": Defaults for actions
|
|
|
| Platform specific tools:
|
| "copy_bundle_data": [iOS, OS X] Tool to copy files in a bundle.
|
| @@ -2696,7 +2704,7 @@
|
|
|
| ```
|
| command [string with substitutions]
|
| - Valid for: all tools (required)
|
| + Valid for: all tools except "action" (required)
|
|
|
| The command to run.
|
|
|
| @@ -2796,6 +2804,7 @@
|
| ]
|
|
|
| pool [label, optional]
|
| + Valid for: all tools (optional)
|
|
|
| Label of the pool to use for the tool. Pools are used to limit the
|
| number of tasks that can execute concurrently during the build.
|
| @@ -2866,13 +2875,13 @@
|
| restat = true
|
|
|
| rspfile [string with substitutions]
|
| - Valid for: all tools (optional)
|
| + Valid for: all tools except "action" (optional)
|
|
|
| Name of the response file. If empty, no response file will be
|
| used. See "rspfile_content".
|
|
|
| rspfile_content [string with substitutions]
|
| - Valid for: all tools (required when "rspfile" is specified)
|
| + Valid for: all tools except "action" (required when "rspfile" is used)
|
|
|
| The contents to be written to the response file. This may include all
|
| or part of the command to send to the tool which allows you to get
|
| @@ -4279,12 +4288,12 @@
|
| }
|
| }
|
| ```
|
| -### <a name="console"></a>**console**: Run this action in the console pool.
|
| +### <a name="console"></a>**console**: Use console pool for the pool object.
|
|
|
| ```
|
| Boolean. Defaults to false.
|
|
|
| - Actions marked "console = true" will be run in the built-in ninja "console"
|
| + Pool objects marked "console = true" will use the built-in ninja "console"
|
| pool. They will have access to real stdin and stdout, and output will not be
|
| buffered by ninja. This can be useful for long-running actions with progress
|
| logs, or actions that require user input.
|
| @@ -4296,7 +4305,7 @@
|
| #### **Example**
|
|
|
| ```
|
| - action("long_action_with_progress_logs") {
|
| + pool("action_pool") {
|
| console = true
|
| }
|
| ```
|
|
|