diff options
author | Steven Knight <knight@baldmt.com> | 2005-03-06 00:45:02 (GMT) |
---|---|---|
committer | Steven Knight <knight@baldmt.com> | 2005-03-06 00:45:02 (GMT) |
commit | abb351362b4075603f829b0dd9cc9aeedaa6f70b (patch) | |
tree | 25e8b37a7f64518d57111a052d7e017a56ebfdc7 /doc/man | |
parent | 37f7563ea516a39234fc91a8ffd9cf22d9258e8b (diff) | |
download | SCons-abb351362b4075603f829b0dd9cc9aeedaa6f70b.zip SCons-abb351362b4075603f829b0dd9cc9aeedaa6f70b.tar.gz SCons-abb351362b4075603f829b0dd9cc9aeedaa6f70b.tar.bz2 |
Make the GenerateHelpText format easily configurable.
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/scons.1 | 38 |
1 files changed, 34 insertions, 4 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1 index ae57f82..3aac25c 100644 --- a/doc/man/scons.1 +++ b/doc/man/scons.1 @@ -7723,6 +7723,18 @@ the Environment() function: env = Environment(options=opts) .EE +.IP +The text file(s) that were specified +when the Options object was created +are executed as Python scripts, +and the values of (global) Python variables set in the file +are added to the construction environment. +Example: + +.ES +CC = 'my_cc' +.EE + .TP .RI Save( filename ", " env ) This saves the currently set options into a script file named @@ -7766,12 +7778,30 @@ Help(opts.GenerateHelpText(env)) Help(opts.GenerateHelpText(env, sort=cmp)) .EE -The text based SConscript file is executed as a Python script, and the -global variables are queried for customizable construction -variables. Example: +.TP +.RI FormatOptionHelpText( env ", " opt ", " help ", " default ", " actual ) +This method returns a formatted string +containing the printable help text +for one option. +It is normally not called directly, +but is called by the +.IR GenerateHelpText () +method to create the returned help text. +It may be overridden with your own +function that takes the arguments specified above +and returns a string of help text formatted to your liking. +Note that the +.IR GenerateHelpText () +will not put any blank lines or extra +characters in between the entries, +so you must add those characters to the returned +string if you want the entries separated. .ES -CC = 'my_cc' +def my_format(env, opt, help, default, actual): + fmt = "\n%s: default=%s actual=%s (%s)\n" + return fmt % (opt, default. actual, help) +opts.FormatOptionHelpText = my_format .EE To make it more convenient to work with customizable Options, |