summaryrefslogtreecommitdiffstats
path: root/doc/user/main.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/main.xml')
-rw-r--r--doc/user/main.xml79
1 files changed, 27 insertions, 52 deletions
diff --git a/doc/user/main.xml b/doc/user/main.xml
index 0dbadfc..181b2a8 100644
--- a/doc/user/main.xml
+++ b/doc/user/main.xml
@@ -56,21 +56,23 @@
<!ENTITY command-line SYSTEM "command-line.xml">
<!ENTITY copyright SYSTEM "copyright.xml">
<!ENTITY depends SYSTEM "depends.xml">
- <!ENTITY ENV_file SYSTEM "ENV.xml">
<!ENTITY environments SYSTEM "environments.xml">
<!ENTITY errors SYSTEM "errors.xml">
<!ENTITY example SYSTEM "example.xml">
<!ENTITY factories SYSTEM "factories.xml">
<!ENTITY file-removal SYSTEM "file-removal.xml">
- <!ENTITY help SYSTEM "help.xml">
<!ENTITY hierarchy SYSTEM "hierarchy.xml">
<!ENTITY java SYSTEM "java.xml">
<!ENTITY install SYSTEM "install.xml">
<!ENTITY less-simple SYSTEM "less-simple.xml">
<!ENTITY libraries SYSTEM "libraries.xml">
<!ENTITY make SYSTEM "make.xml">
+ <!ENTITY mergeflags SYSTEM "mergeflags.xml">
+ <!ENTITY misc SYSTEM "misc.xml">
<!ENTITY nodes SYSTEM "nodes.xml">
+ <!ENTITY output SYSTEM "output.xml">
<!ENTITY parseconfig SYSTEM "parseconfig.xml">
+ <!ENTITY parseflags SYSTEM "parseflags.xml">
<!ENTITY preface SYSTEM "preface.xml">
<!ENTITY python SYSTEM "python.xml">
<!ENTITY repositories SYSTEM "repositories.xml">
@@ -83,7 +85,7 @@
<!ENTITY tasks SYSTEM "tasks.xml">
<!ENTITY tools SYSTEM "tools.xml">
<!ENTITY troubleshoot SYSTEM "troubleshoot.xml">
- <!ENTITY variables SYSTEM "variables.xml">
+ <!ENTITY variables-xml SYSTEM "variables.xml">
<!ENTITY variants SYSTEM "variants.xml">
<!ENTITY builders-gen SYSTEM "builders.gen">
@@ -94,59 +96,27 @@
<!--
- XXX AllowSubstExceptions()
- XXX EnsurePythonVersion()
- XXX EnsureSConsVersion()
- XXX Exit()
XXX FindFile()
XXX FindPathDirs()
- XXX Flatten()
XXX GetBuildPath()
XXX GetLaunchDir()
- XXX ParseConfig()
- XXX MergeFlags()
- XXX ParseFlags()
-
XXX ParseDepends()
XXX Platform()
XXX SConsignFile()
XXX SideEffect()
XXX Tools()
- XXX GetOption('clean')
- XXX SetOption('clean')
-
XXX GetOption('duplicate')
XXX SetOption('duplicate')
XXX - - duplicate=
- XXX GetOption('help')
- XXX SetOption('help')
-
- XXX GetOption('num_jobs')
- XXX SetOption('num_jobs')
-
- XXX Options.UnknownOption()
-
- XXX GetBuildFailures()
-
- XXX Requires()
-
XXX CheckTypeSize()
- XXX Progress()
-
XXX - - diskcheck=
XXX - - warn=
- XXX ARGLIST
- XXX ARGUMENTS
- XXX BUILD_TARGETS
- XXX COMMAND_LINE_TARGETS
- XXX DEFAULT_TARGETS
-
-->
<book>
@@ -160,10 +130,10 @@
<edition>Revision &buildrevision; (&builddate;)</edition>
- <pubdate>2004, 2005, 2006, 2007</pubdate>
+ <pubdate>2004, 2005, 2006, 2007, 2008</pubdate>
<copyright>
- <year>2004, 2005, 2006, 2007</year>
+ <year>2004, 2005, 2006, 2007, 2008</year>
<holder>Steven Knight</holder>
</copyright>
@@ -211,22 +181,27 @@
</chapter>
<chapter id="chap-environments">
- <title>Construction Environments</title>
+ <title>Environments</title>
&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>
- -->
-
- <chapter id="chap-ENV">
- <title>Controlling the External Environment Used to Execute Build Commands</title>
- &ENV_file;
+ <chapter id="chap-output">
+ <title>Controlling Build Output</title>
+ &output;
</chapter>
<chapter id="chap-command-line">
@@ -234,11 +209,6 @@
&command-line;
</chapter>
- <chapter id="chap-help">
- <title>Providing Build Help: the &Help; Function</title>
- &help;
- </chapter>
-
<chapter id="chap-install">
<title>Installing Files in Other Directories: the &Install; Builder</title>
&install;
@@ -250,7 +220,7 @@
</chapter>
<chapter id="chap-file-removal">
- <title>Preventing Removal of Targets</title>
+ <title>Controlling Removal of Targets</title>
&file-removal;
</chapter>
@@ -354,6 +324,11 @@
-->
+ <chapter id="chap-misc">
+ <title>Miscellaneous Functionality</title>
+ &misc;
+ </chapter>
+
<chapter id="chap-troubleshooting">
<title>Troubleshooting</title>
&troubleshoot;
@@ -361,7 +336,7 @@
<appendix id="app-variables">
<title>Construction Variables</title>
- &variables;
+ &variables-xml;
</appendix>
<appendix id="app-builders">