Additional Help updates

Drop the previous change to join lines even if the option part
overflows its gutter.

Signed-off-by: Mats Wichmann <mats@linux.com>

1 files changed, 63 insertions, 60 deletions

diff --git a/SCons/Script/SConsOptions.py b/SCons/Script/SConsOptions.py
index 3a1393455..e2631fb85 100644
--- a/SCons/Script/SConsOptions.py
+++ b/SCons/Script/SConsOptions.py
@@ -24,6 +24,7 @@
 import gettext
 import optparse
 import re
+import shutil
 import sys
 import textwrap
 
@@ -490,7 +491,6 @@ class SConsIndentedHelpFormatter(optparse.IndentedHelpFormatter):
           (so things like ``--no-print-directory`` don't get broken).
         * wrap the list of options themselves when it's too long
           (the ``wrapper.fill(opts)`` call below).
-        * if it would all fit on one line even if opts are long, don't break.
         * set the :attr:`subsequent_indent` when wrapping the :attr:`help_text`.
 
         The help for each option consists of two parts:
@@ -516,11 +516,13 @@ class SConsIndentedHelpFormatter(optparse.IndentedHelpFormatter):
         opt_width = self.help_position - self.current_indent - 2
         # SCons: pre-compute if we could combine opts and text on one line,
         # even if opts spills over opt_width. Saves some lines.
+        # Note: check is currently disabled and this removed from docstring:
+        # * if it would all fit on one line even if opts are long, don't break.
         combine_anyway = False
         if option.help:
             help_text = self.expand_default(option)
-            if len(opts) > opt_width and len(opts) + len(help_text) + 2 <= self.width:
-                combine_anyway = True
+            # if len(opts) > opt_width and len(opts) + len(help_text) + 2 <= self.width:
+            #     combine_anyway = True
         if len(opts) > opt_width and not combine_anyway:
             # SCons: wrap options if needed
             wrapper = textwrap.TextWrapper(
@@ -570,7 +572,8 @@ def Parser(version):
     will at least show up when grepping the source for option attribute
     names, or otherwise browsing the source code.
     """
-    formatter = SConsIndentedHelpFormatter(max_help_position=30)
+    columns, lines = shutil.get_terminal_size()
+    formatter = SConsIndentedHelpFormatter(max_help_position=30, width=columns)
     op = SConsOptionParser(
         option_class=SConsOption,
         add_help_option=False,
@@ -597,41 +600,41 @@ def Parser(version):
     op.add_option('-c', '--clean', '--remove',
                   dest="clean", default=False,
                   action="store_true",
-                  help="Remove specified targets and dependencies.")
+                  help="Remove specified targets and dependencies")
 
     op.add_option('-C', '--directory',
                   nargs=1, type="string",
                   dest="directory", default=[],
                   action="append",
-                  help="Change to DIR before doing anything.",
+                  help="Change to DIR before doing anything",
                   metavar="DIR")
 
     op.add_option('--cache-debug',
                   nargs=1,
                   dest="cache_debug", default=None,
                   action="store",
-                  help="Print CacheDir debug info to FILE.",
+                  help="Print CacheDir debug info to FILE",
                   metavar="FILE")
 
     op.add_option('--cache-disable', '--no-cache',
                   dest='cache_disable', default=False,
                   action="store_true",
-                  help="Do not retrieve built targets from CacheDir.")
+                  help="Do not retrieve built targets from CacheDir")
 
     op.add_option('--cache-force', '--cache-populate',
                   dest='cache_force', default=False,
                   action="store_true",
-                  help="Copy already-built targets into the CacheDir.")
+                  help="Copy already-built targets into the CacheDir")
 
     op.add_option('--cache-readonly',
                   dest='cache_readonly', default=False,
                   action="store_true",
-                  help="Do not update CacheDir with built targets.")
+                  help="Do not update CacheDir with built targets")
 
     op.add_option('--cache-show',
                   dest='cache_show', default=False,
                   action="store_true",
-                  help="Print build actions for files from CacheDir.")
+                  help="Print build actions for files from CacheDir")
 
     def opt_invalid(group, value, options):
         """report an invalid option from a group"""
@@ -645,7 +648,7 @@ def Parser(version):
 
     config_options = ["auto", "force", "cache"]
 
-    opt_config_help = "Controls Configure subsystem: %s." \
+    opt_config_help = "Controls Configure subsystem [%s]" \
                       % ", ".join(config_options)
 
     op.add_option('--config',
@@ -657,8 +660,8 @@ def Parser(version):
     op.add_option('-D',
                   dest="climb_up", default=None,
                   action="store_const", const=2,
-                  help="Search up directory tree for SConstruct,       "
-                       "build all Default() targets.")
+                  help="Search up directory tree for SConstruct, "
+                       "build all Default() targets")
 
     deprecated_debug_options = {}
 
@@ -698,7 +701,7 @@ def Parser(version):
                 raise OptionValueError(opt_invalid(
                     'debug', value, debug_options))
 
-    opt_debug_help = "Print various types of debugging information: %s." \
+    opt_debug_help = "Print various types of debugging information [%s]" \
                      % ", ".join(debug_options)
     op.add_option('--debug',
                   nargs=1, type="string",
@@ -718,7 +721,7 @@ def Parser(version):
                   nargs=1, type="string",
                   dest='diskcheck', default=None,
                   action="callback", callback=opt_diskcheck,
-                  help="Enable specific on-disk checks.",
+                  help="Enable specific on-disk checks",
                   metavar="TYPE")
 
     def opt_duplicate(option, opt, value, parser):
@@ -730,8 +733,8 @@ def Parser(version):
         # of SConscript files.
         SCons.Node.FS.set_duplicate(value)
 
-    opt_duplicate_help = "Set the preferred duplication methods. Must be one of " \
-                         + ", ".join(SCons.Node.FS.Valid_Duplicates)
+    opt_duplicate_help = "Set the preferred duplication methods [%s]" \
+                         % ", ".join(SCons.Node.FS.Valid_Duplicates)
 
     op.add_option('--duplicate',
                   nargs=1, type="string",
@@ -782,16 +785,16 @@ def Parser(version):
                   nargs=1, type="string",
                   dest="file", default=[],
                   action="append",
-                  help="Read FILE as the top-level SConstruct file.")
+                  help="Read FILE as the top-level SConstruct file")
 
     op.add_option('-h', '--help',
                   dest="help", default=False,
                   action="store_true",
-                  help="Print defined help message, or this one.")
+                  help="Print defined help message, or this one")
 
     op.add_option("-H", "--help-options",
                   action="help",
-                  help="Print this message and exit.")
+                  help="Print this message and exit")
 
     def warn_md5_chunksize_deprecated(option, opt, value, parser):
         if opt == '--md5-chunksize':
@@ -805,25 +808,25 @@ def Parser(version):
                   nargs=1, type="int",
                   dest='md5_chunksize', default=SCons.Node.FS.File.hash_chunksize,
                   action="callback",
-                  help="Set chunk-size for hash signature computation to N kilobytes.",
+                  help="Set chunk-size for hash signature computation to N kilobytes",
                   callback=warn_md5_chunksize_deprecated,
                   metavar="N")
 
     op.add_option('--hash-format',
                   dest='hash_format',
                   action='store',
-                  help='Hash format (e.g. md5, sha1, or sha256).')
+                  help='Hash format [md5, sha1, sha256, etc].')
 
     op.add_option('-i', '--ignore-errors',
                   dest='ignore_errors', default=False,
                   action="store_true",
-                  help="Ignore errors from build actions.")
+                  help="Ignore errors from build actions")
 
     op.add_option('-I', '--include-dir',
                   nargs=1,
                   dest='include_dir', default=[],
                   action="append",
-                  help="Search DIR for imported Python modules.",
+                  help="Search DIR for imported Python modules",
                   metavar="DIR")
 
     op.add_option('--ignore-virtualenv',
@@ -843,93 +846,93 @@ def Parser(version):
     op.add_option('--implicit-deps-changed',
                   dest="implicit_deps_changed", default=False,
                   action="callback", callback=opt_implicit_deps,
-                  help="Ignore cached implicit dependencies.")
+                  help="Ignore cached implicit dependencies")
 
     op.add_option('--implicit-deps-unchanged',
                   dest="implicit_deps_unchanged", default=False,
                   action="callback", callback=opt_implicit_deps,
-                  help="Ignore changes in implicit dependencies.")
+                  help="Ignore changes in implicit dependencies")
 
     op.add_option('--interact', '--interactive',
                   dest='interactive', default=False,
                   action="store_true",
-                  help="Run in interactive mode.")
+                  help="Run in interactive mode")
 
     op.add_option('-j', '--jobs',
                   nargs=1, type="int",
                   dest="num_jobs", default=1,
                   action="store",
-                  help="Allow N jobs at once.",
+                  help="Allow N jobs at once",
                   metavar="N")
 
     op.add_option('-k', '--keep-going',
                   dest='keep_going', default=False,
                   action="store_true",
-                  help="Keep going when a target can't be made.")
+                  help="Keep going when a target can't be made")
 
     op.add_option('--max-drift',
                   nargs=1, type="int",
                   dest='max_drift', default=SCons.Node.FS.default_max_drift,
                   action="store",
-                  help="Set maximum system clock drift to N seconds.",
+                  help="Set maximum system clock drift to N seconds",
                   metavar="N")
 
     op.add_option('-n', '--no-exec', '--just-print', '--dry-run', '--recon',
                   dest='no_exec', default=False,
                   action="store_true",
-                  help="Don't build; just print commands.")
+                  help="Don't build; just print commands")
 
     op.add_option('--no-site-dir',
                   dest='site_dir',
                   action="store_false",
-                  help="Don't search or use the usual site_scons dir.")
+                  help="Don't search or use the usual site_scons dir")
 
     op.add_option('--profile',
                   nargs=1,
                   dest="profile_file", default=None,
                   action="store",
-                  help="Profile SCons and put results in FILE.",
+                  help="Profile SCons and put results in FILE",
                   metavar="FILE")
 
     op.add_option('-q', '--question',
                   dest="question", default=False,
                   action="store_true",
-                  help="Don't build; exit status says if up to date.")
+                  help="Don't build; exit status says if up to date")
 
     op.add_option('-Q',
                   dest='no_progress', default=False,
                   action="store_true",
-                  help="Suppress \"Reading/Building\" progress messages.")
+                  help="Suppress \"Reading/Building\" progress messages")
 
     op.add_option('--random',
                   dest="random", default=False,
                   action="store_true",
-                  help="Build dependencies in random order.")
+                  help="Build dependencies in random order")
 
     op.add_option('-s', '--silent', '--quiet',
                   dest="silent", default=False,
                   action="store_true",
-                  help="Don't print commands.")
+                  help="Don't print commands")
 
     op.add_option('--site-dir',
                   nargs=1,
                   dest='site_dir', default=None,
                   action="store",
-                  help="Use DIR instead of the usual site_scons dir.",
+                  help="Use DIR instead of the usual site_scons dir",
                   metavar="DIR")
 
     op.add_option('--stack-size',
                   nargs=1, type="int",
                   dest='stack_size',
                   action="store",
-                  help="Set the stack size of the threads used to run jobs to N kilobytes.",
+                  help="Set the stack size of the threads used to run jobs to N kilobytes",
                   metavar="N")
 
     op.add_option('--taskmastertrace',
                   nargs=1,
                   dest="taskmastertrace_file", default=None,
                   action="store",
-                  help="Trace Node evaluation to FILE.",
+                  help="Trace Node evaluation to FILE",
                   metavar="FILE")
 
     tree_options = ["all", "derived", "prune", "status", "linedraw"]
@@ -951,7 +954,7 @@ def Parser(version):
                 raise OptionValueError(opt_invalid('--tree', o, tree_options))
         parser.values.tree_printers.append(tp)
 
-    opt_tree_help = "Print a dependency tree in various formats: %s." \
+    opt_tree_help = "Print a dependency tree in various formats [%s]" \
                     % ", ".join(tree_options)
 
     op.add_option('--tree',
@@ -964,14 +967,14 @@ def Parser(version):
     op.add_option('-u', '--up', '--search-up',
                   dest="climb_up", default=0,
                   action="store_const", const=1,
-                  help="Search up directory tree for SConstruct,       "
-                       "build targets at or below current directory.")
+                  help="Search up directory tree for SConstruct, "
+                       "build targets at or below current directory")
 
     op.add_option('-U',
                   dest="climb_up", default=0,
                   action="store_const", const=3,
-                  help="Search up directory tree for SConstruct,       "
-                       "build Default() targets from local SConscript.")
+                  help="Search up directory tree for SConstruct, "
+                       "build Default() targets from local SConscript")
 
     def opt_version(option, opt, value, parser):
         sys.stdout.write(parser.version + '\n')
@@ -979,7 +982,7 @@ def Parser(version):
 
     op.add_option("-v", "--version",
                   action="callback", callback=opt_version,
-                  help="Print the SCons version number and exit.")
+                  help="Print the SCons version number and exit")
 
     def opt_warn(option, opt, value, parser, tree_options=tree_options):
         if SCons.Util.is_String(value):
@@ -990,14 +993,14 @@ def Parser(version):
                   nargs=1, type="string",
                   dest="warn", default=[],
                   action="callback", callback=opt_warn,
-                  help="Enable or disable warnings.",
+                  help="Enable or disable warnings",
                   metavar="WARNING-SPEC")
 
     op.add_option('-Y', '--repository', '--srcdir',
                   nargs=1,
                   dest="repository", default=[],
                   action="append",
-                  help="Search REPOSITORY for source and target files.")
+                  help="Search REPOSITORY for source and target files")
 
     # Options from Make and Cons classic that we do not yet support,
     # but which we may support someday and whose (potential) meanings
@@ -1014,62 +1017,62 @@ def Parser(version):
                   action="callback", callback=opt_not_yet,
                   # action="store",
                   # help="Don't start multiple jobs unless load is below "
-                  #      "LOAD-AVERAGE."
+                  #      "LOAD-AVERAGE"
                   help=SUPPRESS_HELP)
     op.add_option('--list-actions',
                   dest="list_actions",
                   action="callback", callback=opt_not_yet,
-                  # help="Don't build; list files and build actions."
+                  # help="Don't build; list files and build actions"
                   help=SUPPRESS_HELP)
     op.add_option('--list-derived',
                   dest="list_derived",
                   action="callback", callback=opt_not_yet,
-                  # help="Don't build; list files that would be built."
+                  # help="Don't build; list files that would be built"
                   help=SUPPRESS_HELP)
     op.add_option('--list-where',
                   dest="list_where",
                   action="callback", callback=opt_not_yet,
-                  # help="Don't build; list files and where defined."
+                  # help="Don't build; list files and where defined"
                   help=SUPPRESS_HELP)
     op.add_option('-o', '--old-file', '--assume-old',
                   nargs=1, type="string",
                   dest="old_file", default=[],
                   action="callback", callback=opt_not_yet,
                   # action="append",
-                  # help = "Consider FILE to be old; don't rebuild it."
+                  # help = "Consider FILE to be old; don't rebuild it"
                   help=SUPPRESS_HELP)
     op.add_option('--override',
                   nargs=1, type="string",
                   action="callback", callback=opt_not_yet,
                   dest="override",
-                  # help="Override variables as specified in FILE."
+                  # help="Override variables as specified in FILE"
                   help=SUPPRESS_HELP)
     op.add_option('-p',
                   action="callback", callback=opt_not_yet,
                   dest="p",
-                  # help="Print internal environments/objects."
+                  # help="Print internal environments/objects"
                   help=SUPPRESS_HELP)
     op.add_option('-r', '-R', '--no-builtin-rules', '--no-builtin-variables',
                   action="callback", callback=opt_not_yet,
                   dest="no_builtin_rules",
-                  # help="Clear default environments and variables."
+                  # help="Clear default environments and variables"
                   help=SUPPRESS_HELP)
     op.add_option('--write-filenames',
                   nargs=1, type="string",
                   dest="write_filenames",
                   action="callback", callback=opt_not_yet,
-                  # help="Write all filenames examined into FILE."
+                  # help="Write all filenames examined into FILE"
                   help=SUPPRESS_HELP)
     op.add_option('-W', '--new-file', '--assume-new', '--what-if',
                   nargs=1, type="string",
                   dest="new_file",
                   action="callback", callback=opt_not_yet,
-                  # help="Consider FILE to be changed."
+                  # help="Consider FILE to be changed"
                   help=SUPPRESS_HELP)
     op.add_option('--warn-undefined-variables',
                   dest="warn_undefined_variables",
                   action="callback", callback=opt_not_yet,
-                  # help="Warn when an undefined variable is referenced."
+                  # help="Warn when an undefined variable is referenced"
                   help=SUPPRESS_HELP)
     return op