summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Script/SConscript.xml
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2016-05-08 23:27:44 (GMT)
committerWilliam Deegan <bill@baddogconsulting.com>2016-05-08 23:27:44 (GMT)
commitd86a8cf1f8e5aadca9bcd6b7481ab15eccc0530d (patch)
tree521ddb1071569fa90100e11d7f03af13d5689aaf /src/engine/SCons/Script/SConscript.xml
parent98bb69c7c9e13ea57ae7e6e8db4740a4dd43ed16 (diff)
parent6a37189174372c9c98c63ada58ab4352adf650e8 (diff)
downloadSCons-d86a8cf1f8e5aadca9bcd6b7481ab15eccc0530d.zip
SCons-d86a8cf1f8e5aadca9bcd6b7481ab15eccc0530d.tar.gz
SCons-d86a8cf1f8e5aadca9bcd6b7481ab15eccc0530d.tar.bz2
merged
Diffstat (limited to 'src/engine/SCons/Script/SConscript.xml')
-rw-r--r--src/engine/SCons/Script/SConscript.xml16
1 files changed, 11 insertions, 5 deletions
diff --git a/src/engine/SCons/Script/SConscript.xml b/src/engine/SCons/Script/SConscript.xml
index c74ad5e..8553fbe 100644
--- a/src/engine/SCons/Script/SConscript.xml
+++ b/src/engine/SCons/Script/SConscript.xml
@@ -240,7 +240,7 @@ file is found.
<scons_function name="Help">
<arguments>
-(text)
+(text, append=False)
</arguments>
<summary>
<para>
@@ -248,12 +248,18 @@ This specifies help text to be printed if the
<option>-h</option>
argument is given to
&scons;.
-If
+If
&f-Help;
-is called multiple times, the text is appended together in the order
-that
+is called multiple times, the text is appended together in the order that
&f-Help;
-is called.
+is called. With append set to False, any
+&f-Help;
+text generated with
+&f-AddOption;
+is clobbered. If append is True, the AddOption help is prepended to the help
+string, thus preserving the
+<option>-h</option>
+message.
</para>
</summary>
</scons_function>