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

Side by Side Diff: docs/UserDocumentation.md

Issue 1292053003: Lots of documentation cleanup (Closed) Base URL: https://chromium.googlesource.com/external/gyp@md-pages
Patch Set: more nits Created 5 years, 4 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 | « docs/Testing.md ('k') | index.md » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 # GYP (Generate Your Projects) User Documentation 1 # User Documentation
2 2
3 Status: Draft (as of 2009-05-19)
4
5 Mark Mentovai <mark@chromium.org>,
6 Steven Knight <sgk@chromium.org>
7 _et al._
8
9 Modified: 2009-05-19
10
11 [TOC] 3 [TOC]
12 4
13 ## Introduction 5 ## Introduction
14 6
15 This document is intended to provide a user-level guide to GYP. The 7 This document is intended to provide a user-level guide to GYP. The
16 emphasis here is on how to use GYP to accomplish specific tasks, not on 8 emphasis here is on how to use GYP to accomplish specific tasks, not on
17 the complete technical language specification. (For that, see the 9 the complete technical language specification. (For that, see the
18 [LanguageSpecification](LanguageSpecification).) 10 [LanguageSpecification](LanguageSpecification).)
19 11
20 The document below starts with some overviews to provide context: an 12 The document below starts with some overviews to provide context: an
(...skipping 418 matching lines...) Expand 10 before | Expand all | Expand 10 after
439 431
440 The above two examples end up generating equivalent builds, with the 432 The above two examples end up generating equivalent builds, with the
441 small exception that the `sources` lists will list the files in 433 small exception that the `sources` lists will list the files in
442 different orders. (The first example defines explicitly where 434 different orders. (The first example defines explicitly where
443 `linux_specific.cc` appears in the list--perhaps in in the 435 `linux_specific.cc` appears in the list--perhaps in in the
444 middle--whereas the second example will always tack it on to the end of 436 middle--whereas the second example will always tack it on to the end of
445 the list.) 437 the list.)
446 438
447 **Including or excluding files using patterns**: There are more 439 **Including or excluding files using patterns**: There are more
448 complicated ways to construct a `sources` list based on patterns. See 440 complicated ways to construct a `sources` list based on patterns. See
449 `TODO(sgk)` below. 441 `TODO` below.
450 442
451 ### Add a new executable 443 ### Add a new executable
452 444
453 An executable program is probably the most straightforward type of 445 An executable program is probably the most straightforward type of
454 target, since all it typically needs is a list of source files, some 446 target, since all it typically needs is a list of source files, some
455 compiler/linker settings (probably varied by platform), and some library 447 compiler/linker settings (probably varied by platform), and some library
456 targets on which it depends and which must be used in the final link. 448 targets on which it depends and which must be used in the final link.
457 449
458 #### Add an executable that builds on all platforms 450 #### Add an executable that builds on all platforms
459 451
(...skipping 489 matching lines...) Expand 10 before | Expand all | Expand 10 after
949 setting `product_extension` if you want. Files listed in 941 setting `product_extension` if you want. Files listed in
950 `mac_bundle_resources` will be copied to the bundle's `Resource` folder 942 `mac_bundle_resources` will be copied to the bundle's `Resource` folder
951 of the bundle. You can also set 943 of the bundle. You can also set
952 `process_outputs_as_mac_bundle_resources` to 1 in actions and rules to 944 `process_outputs_as_mac_bundle_resources` to 1 in actions and rules to
953 let the output of actions and rules be added to that folder (similar to 945 let the output of actions and rules be added to that folder (similar to
954 `process_outputs_as_sources`). If `product_name` is not set, the bundle 946 `process_outputs_as_sources`). If `product_name` is not set, the bundle
955 will be named after `target_name`as usual. 947 will be named after `target_name`as usual.
956 948
957 ### Move files (refactoring) 949 ### Move files (refactoring)
958 950
959 TODO(sgk) 951 TODO
960 952
961 ### Custom build steps 953 ### Custom build steps
962 954
963 TODO(sgk) 955 TODO
964 956
965 #### Adding an explicit build step to generate specific files 957 #### Adding an explicit build step to generate specific files
966 958
967 TODO(sgk) 959 TODO
968 960
969 #### Adding a rule to handle files with a new suffix 961 #### Adding a rule to handle files with a new suffix
970 962
971 TODO(sgk) 963 TODO
972 964
973 ### Build flavors 965 ### Build flavors
974 966
975 TODO(sgk) 967 TODO
OLDNEW
« no previous file with comments | « docs/Testing.md ('k') | index.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698