diff options
| author | Steven Knight <knight@baldmt.com> | 2010-07-05 15:16:54 (GMT) |
|---|---|---|
| committer | Steven Knight <knight@baldmt.com> | 2010-07-05 15:16:54 (GMT) |
| commit | 8b69585750cb1874419a084a81d809fce009c839 (patch) | |
| tree | e5792ecfaee51e64214d36581ac0dd3211bdd945 /doc | |
| parent | de01f980b8b6d59088fdc739535cf12f050ed36b (diff) | |
| download | SCons-8b69585750cb1874419a084a81d809fce009c839.zip SCons-8b69585750cb1874419a084a81d809fce009c839.tar.gz SCons-8b69585750cb1874419a084a81d809fce009c839.tar.bz2 | |
Issue 2654: Consolidate three chapters into one. (Greg Noel)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/user/main.in | 41 | ||||
| -rw-r--r-- | doc/user/main.xml | 41 |
2 files changed, 58 insertions, 24 deletions
diff --git a/doc/user/main.in b/doc/user/main.in index 5bf274a..d592c49 100644 --- a/doc/user/main.in +++ b/doc/user/main.in @@ -177,18 +177,35 @@ &environments; </chapter> - <!-- These next three sections should be combined into one chapter --> - <chapter id="chap-mergeflags"> - <title>Merging Options into the Environment: the &MergeFlags; Function</title> - &mergeflags; - </chapter> - <chapter id="chap-parseflags"> - <title>Separating Compile Arguments into their Variables: the &ParseFlags; Function</title> - &parseflags; - </chapter> - <chapter id="chap-parseconfig"> - <title>Finding Installed Library Information: the &ParseConfig; Function</title> - &parseconfig; + <chapter id="chap-manip-options"> + <title>Automatically Putting Command-line Options into their Construction Variables</title> + <!-- TODO: This intro paragraph should describe at a high-level + what these things do. People are likely to use the intro as a + (brief) overview of *what* these functions do to decide if this + chapter is where they should read in more detail. --> + <para> + This chapter describes the &MergeFlags;, &ParseFlags;, and &ParseConfig; methods of a &consenv;. + </para> + <section id="sect-mergeflags"> + <title>Merging Options into the Environment: the &MergeFlags; Function</title> + &mergeflags; + </section> + <section id="sect-parseflags"> + <title>Separating Compile Arguments into their Variables: the &ParseFlags; Function</title> + &parseflags; + </section> + <section id="sect-parseconfig"> + <title>Finding Installed Library Information: the &ParseConfig; Function</title> + &parseconfig; + </section> + <!-- + XXX parse_flags= option of Environment() + + <section id="sect-env-parseflags"> + <title>Adding Flags when Constructing Enviroment: the parse_flags Optional Argument</title> + &envparseflags; + </section> + --> </chapter> <chapter id="chap-output"> diff --git a/doc/user/main.xml b/doc/user/main.xml index 5bf274a..d592c49 100644 --- a/doc/user/main.xml +++ b/doc/user/main.xml @@ -177,18 +177,35 @@ &environments; </chapter> - <!-- These next three sections should be combined into one chapter --> - <chapter id="chap-mergeflags"> - <title>Merging Options into the Environment: the &MergeFlags; Function</title> - &mergeflags; - </chapter> - <chapter id="chap-parseflags"> - <title>Separating Compile Arguments into their Variables: the &ParseFlags; Function</title> - &parseflags; - </chapter> - <chapter id="chap-parseconfig"> - <title>Finding Installed Library Information: the &ParseConfig; Function</title> - &parseconfig; + <chapter id="chap-manip-options"> + <title>Automatically Putting Command-line Options into their Construction Variables</title> + <!-- TODO: This intro paragraph should describe at a high-level + what these things do. People are likely to use the intro as a + (brief) overview of *what* these functions do to decide if this + chapter is where they should read in more detail. --> + <para> + This chapter describes the &MergeFlags;, &ParseFlags;, and &ParseConfig; methods of a &consenv;. + </para> + <section id="sect-mergeflags"> + <title>Merging Options into the Environment: the &MergeFlags; Function</title> + &mergeflags; + </section> + <section id="sect-parseflags"> + <title>Separating Compile Arguments into their Variables: the &ParseFlags; Function</title> + &parseflags; + </section> + <section id="sect-parseconfig"> + <title>Finding Installed Library Information: the &ParseConfig; Function</title> + &parseconfig; + </section> + <!-- + XXX parse_flags= option of Environment() + + <section id="sect-env-parseflags"> + <title>Adding Flags when Constructing Enviroment: the parse_flags Optional Argument</title> + &envparseflags; + </section> + --> </chapter> <chapter id="chap-output"> |