Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(67)

Side by Side Diff: tools/gn/docs/reference.md

Issue 1097423002: Stop generating the [TOC] in the GN reference docs. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 5 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « tools/gn/command_help.cc ('k') | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 # GN Reference 1 # GN Reference
2 2
3 [TOC]
4
5 *This page is automatically generated from* `gn help --markdown all`. 3 *This page is automatically generated from* `gn help --markdown all`.
6 4
7 ## **--args**: Specifies build arguments overrides. 5 ## **--args**: Specifies build arguments overrides.
8 6
9 ``` 7 ```
10 See "gn help buildargs" for an overview of how build arguments work. 8 See "gn help buildargs" for an overview of how build arguments work.
11 9
12 Most operations take a build directory. The build arguments are taken 10 Most operations take a build directory. The build arguments are taken
13 from the previous build done in that directory. If a command specifies 11 from the previous build done in that directory. If a command specifies
14 --args, it will override the previous arguments stored in the build 12 --args, it will override the previous arguments stored in the build
(...skipping 543 matching lines...) Expand 10 before | Expand all | Expand 10 after
558 556
559 gn ls out/Debug "//base/*" --as=output | xargs ninja -C out/Debug 557 gn ls out/Debug "//base/*" --as=output | xargs ninja -C out/Debug
560 Builds all targets in //base and all subdirectories. 558 Builds all targets in //base and all subdirectories.
561 559
562 gn ls out/Debug //base --all-toolchains 560 gn ls out/Debug //base --all-toolchains
563 Lists all variants of the target //base:base (it may be referenced 561 Lists all variants of the target //base:base (it may be referenced
564 in multiple toolchains). 562 in multiple toolchains).
565 563
566 564
567 ``` 565 ```
568 ## **gn refs <out_dir> (<label_pattern>|<label>|<file>)* [--all]** 566 ## **gn refs <out_dir> (<label_pattern>|<label>|<file>|@<response_file>)* [--all ]**
569 ``` 567 ```
570 [--all-toolchains] [--as=...] [--testonly=...] [--type=...] 568 [--all-toolchains] [--as=...] [--testonly=...] [--type=...]
571 569
572 Finds reverse dependencies (which targets reference something). The 570 Finds reverse dependencies (which targets reference something). The
573 input is a list containing: 571 input is a list containing:
574 572
575 - Target label: The result will be which targets depend on it. 573 - Target label: The result will be which targets depend on it.
576 574
577 - Config label: The result will be which targets list the given 575 - Config label: The result will be which targets list the given
578 config in its "configs" or "public_configs" list. 576 config in its "configs" or "public_configs" list.
579 577
580 - Label pattern: The result will be which targets depend on any 578 - Label pattern: The result will be which targets depend on any
581 target matching the given pattern. Patterns will not match 579 target matching the given pattern. Patterns will not match
582 configs. These are not general regular expressions, see 580 configs. These are not general regular expressions, see
583 "gn help label_pattern" for details. 581 "gn help label_pattern" for details.
584 582
585 - File name: The result will be which targets list the given file in 583 - File name: The result will be which targets list the given file in
586 its "inputs", "sources", "public", or "data". Any input 584 its "inputs", "sources", "public", or "data". Any input
587 that does not contain wildcards and does not match a target or a 585 that does not contain wildcards and does not match a target or a
588 config will be treated as a file. 586 config will be treated as a file.
589 587
588 - Response file: If the input starts with an "@", it will be
589 interpreted as a path to a file containing a list of labels or
590 file names, one per line. This allows us to handle long lists
591 of inputs without worrying about command line limits.
592
590 ``` 593 ```
591 594
592 ### **Options** 595 ### **Options**
593 596
594 ``` 597 ```
595 --all 598 --all
596 When used without --tree, will recurse and display all unique 599 When used without --tree, will recurse and display all unique
597 dependencies of the given targets. For example, if the input is 600 dependencies of the given targets. For example, if the input is
598 a target, this will output all targets that depend directly or 601 a target, this will output all targets that depend directly or
599 indirectly on the input. If the input is a file, this will output 602 indirectly on the input. If the input is a file, this will output
(...skipping 3692 matching lines...) Expand 10 before | Expand all | Expand 10 after
4292 ** --markdown**: write the output in the Markdown format. 4295 ** --markdown**: write the output in the Markdown format.
4293 ** --nocolor**: Force non-colored output. 4296 ** --nocolor**: Force non-colored output.
4294 ** -q**: Quiet mode. Don't print output on success. 4297 ** -q**: Quiet mode. Don't print output on success.
4295 ** --root**: Explicitly specify source root. 4298 ** --root**: Explicitly specify source root.
4296 ** --time**: Outputs a summary of how long everything took. 4299 ** --time**: Outputs a summary of how long everything took.
4297 ** --tracelog**: Writes a Chrome-compatible trace log to the given file. 4300 ** --tracelog**: Writes a Chrome-compatible trace log to the given file.
4298 ** -v**: Verbose logging. 4301 ** -v**: Verbose logging.
4299 ** --version**: Prints the GN version number and exits. 4302 ** --version**: Prints the GN version number and exits.
4300 4303
4301 ``` 4304 ```
OLDNEW
« no previous file with comments | « tools/gn/command_help.cc ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698