summaryrefslogtreecommitdiff
path: root/doc/user
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2015-09-29 10:04:02 -0700
committerWilliam Deegan <bill@baddogconsulting.com>2015-09-29 10:04:02 -0700
commitec51b69ea5ed266cef7be71ee1224081b990e01e (patch)
tree6ed95a9bb7b6256864a971d90c8f099fba0f010b /doc/user
parentb5e7eb1f92599801f943ad8ad568e089ec7db315 (diff)
parentf348823065b4ea605d03bdc16c1105fc25f93da0 (diff)
downloadscons-ec51b69ea5ed266cef7be71ee1224081b990e01e.tar.gz
Merged in carandraug/scons (pull request #248)
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/build-install.xml2
-rw-r--r--doc/user/output.xml22
-rw-r--r--doc/user/titlepage/SConsBuildBricks_path.svg22
3 files changed, 33 insertions, 13 deletions
diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml
index d107b4a7..3e661720 100644
--- a/doc/user/build-install.xml
+++ b/doc/user/build-install.xml
@@ -231,7 +231,7 @@ Python 2.5.1
<para>
Or, you can use a graphical RPM package manager.
- See your package manager application's documention
+ See your package manager application's documentation
for specific instructions about
how to use it to install a downloaded RPM.
diff --git a/doc/user/output.xml b/doc/user/output.xml
index cdb28d75..78dcca49 100644
--- a/doc/user/output.xml
+++ b/doc/user/output.xml
@@ -83,6 +83,21 @@ Type: 'scons program' to build the production program,
<para>
+ Optionally, one can specify the append flag:
+
+ </para>
+
+ <scons_example name="output_ex1_a">
+ <file name="SConstruct" printme="1">
+Help("""
+Type: 'scons program' to build the production program,
+ 'scons debug' to build the debug version.
+""", append=True)
+ </file>
+ </scons_example>
+
+ <para>
+
(Note the above use of the Python triple-quote syntax,
which comes in very handy for
specifying multi-line strings like help text.)
@@ -120,6 +135,13 @@ Type: 'scons program' to build the production program,
<para>
+ When used with &AddOption; Help("text", append=False) will clobber any help output associated with AddOption().
+ To preserve the help output from AddOption(), set append=True.
+
+ </para>
+
+ <para>
+
Another use would be to make the help text conditional
on some variable.
For example, suppose you only want to display
diff --git a/doc/user/titlepage/SConsBuildBricks_path.svg b/doc/user/titlepage/SConsBuildBricks_path.svg
index ed0c60d7..0d7f63e0 100644
--- a/doc/user/titlepage/SConsBuildBricks_path.svg
+++ b/doc/user/titlepage/SConsBuildBricks_path.svg
@@ -14,9 +14,9 @@
height="80.330002"
id="svg2"
sodipodi:version="0.32"
- inkscape:version="0.48.1 r9760"
+ inkscape:version="0.48.4 r9939"
version="1.0"
- sodipodi:docname="SConsBuildBricks.svg"
+ sodipodi:docname="SConsBuildBricks_path.svg"
inkscape:export-filename="Constructs-using-SCons.png"
inkscape:export-xdpi="100"
inkscape:export-ydpi="100">
@@ -77,24 +77,22 @@
</cc:Agent>
</dc:contributor>
<cc:license
- rdf:resource="http://creativecommons.org/licenses/by-nc-sa/2.0/" />
+ rdf:resource="http://creativecommons.org/licenses/by-sa/3.0/" />
</cc:Work>
<cc:License
- rdf:about="http://creativecommons.org/licenses/by-nc-sa/2.5/">
+ rdf:about="http://creativecommons.org/licenses/by-sa/3.0/">
<cc:permits
- rdf:resource="http://web.resource.org/cc/Reproduction" />
+ rdf:resource="http://creativecommons.org/ns#Reproduction" />
<cc:permits
- rdf:resource="http://web.resource.org/cc/Distribution" />
+ rdf:resource="http://creativecommons.org/ns#Distribution" />
<cc:requires
- rdf:resource="http://web.resource.org/cc/Notice" />
+ rdf:resource="http://creativecommons.org/ns#Notice" />
<cc:requires
- rdf:resource="http://web.resource.org/cc/Attribution" />
- <cc:prohibits
- rdf:resource="http://web.resource.org/cc/CommercialUse" />
+ rdf:resource="http://creativecommons.org/ns#Attribution" />
<cc:permits
- rdf:resource="http://web.resource.org/cc/DerivativeWorks" />
+ rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
<cc:requires
- rdf:resource="http://web.resource.org/cc/ShareAlike" />
+ rdf:resource="http://creativecommons.org/ns#ShareAlike" />
</cc:License>
</rdf:RDF>
</metadata>