summaryrefslogtreecommitdiff
path: root/doc/user/main.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/main.in')
-rw-r--r--doc/user/main.in53
1 files changed, 40 insertions, 13 deletions
diff --git a/doc/user/main.in b/doc/user/main.in
index fbc28df..feb8c25 100644
--- a/doc/user/main.in
+++ b/doc/user/main.in
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<!--
- Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 The SCons Foundation
+ Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 The SCons Foundation
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -37,6 +37,9 @@
<!ENTITY % builders-mod SYSTEM "builders.mod">
%builders-mod;
+ <!ENTITY % functions-mod SYSTEM "functions.mod">
+ %functions-mod;
+
<!ENTITY % tools-mod SYSTEM "tools.mod">
%tools-mod;
@@ -61,6 +64,7 @@
<!ENTITY example SYSTEM "example.xml">
<!ENTITY factories SYSTEM "factories.xml">
<!ENTITY file-removal SYSTEM "file-removal.xml">
+ <!ENTITY functions SYSTEM "functions.xml">
<!ENTITY hierarchy SYSTEM "hierarchy.xml">
<!ENTITY java SYSTEM "java.xml">
<!ENTITY install SYSTEM "install.xml">
@@ -89,6 +93,7 @@
<!ENTITY variants SYSTEM "variants.xml">
<!ENTITY builders-gen SYSTEM "builders.gen">
+ <!ENTITY functions-gen SYSTEM "functions.gen">
<!ENTITY tools-gen SYSTEM "tools.gen">
<!ENTITY variables-gen SYSTEM "variables.gen">
@@ -177,18 +182,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">
@@ -341,6 +363,11 @@
&tools;
</appendix>
+ <appendix id="app-functions">
+ <title>Functions and Environment Methods</title>
+ &functions;
+ </appendix>
+
<appendix id="app-tasks">
<title>Handling Common Tasks</title>
&tasks;