diff options
| author | Steven Knight <knight@baldmt.com> | 2003-04-13 13:25:12 (GMT) |
|---|---|---|
| committer | Steven Knight <knight@baldmt.com> | 2003-04-13 13:25:12 (GMT) |
| commit | 06e013ecd55e950a6059ced4150304c346d1da36 (patch) | |
| tree | fc8bf31a334f55bca5af8440512999baea81f4bb /doc | |
| parent | 5a50b311a2197c327b0b53b302801406289c1fad (diff) | |
| download | SCons-06e013ecd55e950a6059ced4150304c346d1da36.zip SCons-06e013ecd55e950a6059ced4150304c346d1da36.tar.gz SCons-06e013ecd55e950a6059ced4150304c346d1da36.tar.bz2 | |
Add an argument for sorting Options help text.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/scons.1 | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1 index a778c38..32d4bfb 100644 --- a/doc/man/scons.1 +++ b/doc/man/scons.1 @@ -2938,15 +2938,30 @@ opts.Save('options.cache', env) .EE .TP -.RI GenerateHelpText( env ) +.RI GenerateHelpText( env ", [" sort ]) This generates help text documenting the customizable construction variables suitable to passing in to the Help() function. .I env is the construction environment that will be used to get the actual values -of customizable variables. Example: +of customizable variables. Calling with +an optional +.I sort +function +will cause the output to be sorted +by the specified argument. +The specific +.I sort +function +should take two arguments +and return +-1, 0 or 1 +(like the standard Python +.I cmp +function). .ES Help(opts.GenerateHelpText(env)) +Help(opts.GenerateHelpText(env, sort=cmp)) .EE The text based SConscript file is executed as a Python script, and the |