diff options
| author | William Deegan <bill@baddogconsulting.com> | 2015-09-28 13:57:59 -0700 |
|---|---|---|
| committer | William Deegan <bill@baddogconsulting.com> | 2015-09-28 13:57:59 -0700 |
| commit | 41e5bf7b1c90d460970ddcb9f4924828b393751d (patch) | |
| tree | 992bf7275932e5d91280d5fd0e1376e6f2f92520 /doc/user | |
| parent | aeb07cc8cccd59eb727dcf3967f7ad3cdebc8158 (diff) | |
| download | scons-41e5bf7b1c90d460970ddcb9f4924828b393751d.tar.gz | |
Added help for pull request #226
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/output.xml | 22 |
1 files changed, 22 insertions, 0 deletions
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 |