diff options
author | Steven Knight <knight@baldmt.com> | 2005-02-15 13:55:44 (GMT) |
---|---|---|
committer | Steven Knight <knight@baldmt.com> | 2005-02-15 13:55:44 (GMT) |
commit | 62cbc49e4a8cf1aec05e2a81ebce02aa48de01d0 (patch) | |
tree | 18a308eb5aa145b95de56c05aca90a609c3eaaf6 /doc/user/help.in | |
parent | b98a5ace610737d68263702bdd7d9df9b6ab079a (diff) | |
download | SCons-62cbc49e4a8cf1aec05e2a81ebce02aa48de01d0.zip SCons-62cbc49e4a8cf1aec05e2a81ebce02aa48de01d0.tar.gz SCons-62cbc49e4a8cf1aec05e2a81ebce02aa48de01d0.tar.bz2 |
Accumulated documentation changes.
Diffstat (limited to 'doc/user/help.in')
-rw-r--r-- | doc/user/help.in | 61 |
1 files changed, 60 insertions, 1 deletions
diff --git a/doc/user/help.in b/doc/user/help.in index d4b2caa..4356d18 100644 --- a/doc/user/help.in +++ b/doc/user/help.in @@ -61,7 +61,66 @@ </para> <scons_output example="ex1"> - <command>scons -h</command> + <scons_output_command>scons -h</scons_output_command> + </scons_output> + + <para> + + The &SConscript; files may contain + multiple calls to the &Help; function, + in which case the specified text(s) + will be concatenated when displayed. + This allows you to split up the + help text across multiple &SConscript; files. + In this situation, the order in + which the &SConscript; files are called + will determine the order in which the &Help; functions are called, + which will determine the order in which + the various bits of text will get concatenated. + + </para> + + <para> + + Another use would be to make the help text conditional + on some variable. + For example, suppose you only want to display + a line about building a Windows-only + version of a program when actually + run on Windows. + The following &SConstruct; file: + + </para> + + <scons_example name="ex2"> + <file name="SConstruct" printme="1"> + env = Environment() + + Help("\nType: 'scons program' to build the production program.\n") + + if env['PLATFORM'] == 'win32': + Help("\nType: 'scons windebug' to build the Windows debug version.\n") + </file> + </scons_example> + + <para> + + Will display the completely help text on Windows: + + </para> + + <scons_output example="ex2" os="win32"> + <scons_output_command>scons -h</scons_output_command> + </scons_output> + + <para> + + But only show the relevant option on a Linux or UNIX system: + + </para> + + <scons_output example="ex2" os="posix"> + <scons_output_command>scons -h</scons_output_command> </scons_output> <para> |