OLD | NEW |
1 # GN Reference | 1 # GN Reference |
2 | 2 |
3 *This page is automatically generated from* `gn help --markdown all`. | 3 *This page is automatically generated from* `gn help --markdown all`. |
4 | 4 |
5 ## **\--args**: Specifies build arguments overrides. | 5 ## **\--args**: Specifies build arguments overrides. |
6 | 6 |
7 ``` | 7 ``` |
8 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. |
9 | 9 |
10 Most operations take a build directory. The build arguments are taken | 10 Most operations take a build directory. The build arguments are taken |
(...skipping 514 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
525 gn format //some/BUILD.gn | 525 gn format //some/BUILD.gn |
526 gn format some\BUILD.gn | 526 gn format some\BUILD.gn |
527 gn format /abspath/some/BUILD.gn | 527 gn format /abspath/some/BUILD.gn |
528 gn format --stdin | 528 gn format --stdin |
529 | 529 |
530 | 530 |
531 ``` | 531 ``` |
532 ## **gn gen**: Generate ninja files. | 532 ## **gn gen**: Generate ninja files. |
533 | 533 |
534 ``` | 534 ``` |
535 gn gen [--ide=<ide_name>] <out_dir> | 535 gn gen [<ide options>] <out_dir> |
536 | 536 |
537 Generates ninja files from the current tree and puts them in the given | 537 Generates ninja files from the current tree and puts them in the given |
538 output directory. | 538 output directory. |
539 | 539 |
540 The output directory can be a source-repo-absolute path name such as: | 540 The output directory can be a source-repo-absolute path name such as: |
541 //out/foo | 541 //out/foo |
542 Or it can be a directory relative to the current directory such as: | 542 Or it can be a directory relative to the current directory such as: |
543 out/foo | 543 out/foo |
544 | 544 |
| 545 See "gn help switches" for the common command-line switches. |
| 546 |
| 547 ``` |
| 548 |
| 549 ### **IDE options** |
| 550 |
| 551 ``` |
| 552 GN optionally generates files for IDE. Possibilities for <ide options> |
| 553 |
545 --ide=<ide_name> | 554 --ide=<ide_name> |
546 Also generate files for an IDE. Currently supported values: | 555 Generate files for an IDE. Currently supported values: |
547 'vs' - Visual Studio project/solution files. | 556 "eclipse" - Eclipse CDT settings file. |
| 557 "vs" - Visual Studio project/solution files. |
| 558 (default Visual Studio version: 2015) |
| 559 "vs2013" - Visual Studio 2013 project/solution files. |
| 560 "vs2015" - Visual Studio 2015 project/solution files. |
548 | 561 |
549 See "gn help switches" for the common command-line switches. | 562 --sln=<file_name> |
| 563 Override default sln file name ("all"). Solution file is written |
| 564 to the root build directory. Only for Visual Studio. |
| 565 |
| 566 --filters=<path_prefixes> |
| 567 Semicolon-separated list of label patterns used to limit the set |
| 568 of generated projects (see "gn help label_pattern"). Only |
| 569 matching targets will be included to the solution. Only for Visual |
| 570 Studio. |
| 571 |
| 572 ``` |
| 573 |
| 574 ### **Eclipse IDE Support** |
| 575 |
| 576 ``` |
| 577 GN DOES NOT generate Eclipse CDT projects. Instead, it generates a |
| 578 settings file which can be imported into an Eclipse CDT project. The |
| 579 XML file contains a list of include paths and defines. Because GN does |
| 580 not generate a full .cproject definition, it is not possible to |
| 581 properly define includes/defines for each file individually. |
| 582 Instead, one set of includes/defines is generated for the entire |
| 583 project. This works fairly well but may still result in a few indexer |
| 584 issues here and there. |
550 | 585 |
551 | 586 |
552 ``` | 587 ``` |
553 ## **gn help <anything>** | 588 ## **gn help <anything>** |
554 ``` | 589 ``` |
555 Yo dawg, I heard you like help on your help so I put help on the help | 590 Yo dawg, I heard you like help on your help so I put help on the help |
556 in the help. | 591 in the help. |
557 | 592 |
558 | 593 |
559 ``` | 594 ``` |
(...skipping 4751 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
5311 ** -q**: Quiet mode. Don't print output on success. | 5346 ** -q**: Quiet mode. Don't print output on success. |
5312 ** \--root**: Explicitly specify source root. | 5347 ** \--root**: Explicitly specify source root. |
5313 ** \--runtime-deps-list-file**: Save runtime dependencies for targets in file. | 5348 ** \--runtime-deps-list-file**: Save runtime dependencies for targets in file. |
5314 ** \--threads**: Specify number of worker threads. | 5349 ** \--threads**: Specify number of worker threads. |
5315 ** \--time**: Outputs a summary of how long everything took. | 5350 ** \--time**: Outputs a summary of how long everything took. |
5316 ** \--tracelog**: Writes a Chrome-compatible trace log to the given file. | 5351 ** \--tracelog**: Writes a Chrome-compatible trace log to the given file. |
5317 ** -v**: Verbose logging. | 5352 ** -v**: Verbose logging. |
5318 ** \--version**: Prints the GN version number and exits. | 5353 ** \--version**: Prints the GN version number and exits. |
5319 | 5354 |
5320 ``` | 5355 ``` |
OLD | NEW |