Changeset 52725 in webkit

Timestamp:

Jan 4, 2010 2:57:03 AM (14 years ago)

Author:

eric@webkit.org

Message:

2010-01-04 Eric Seidel <​eric@webkit.org>

Reviewed by Adam Barth.

Need support for longer text in per-command help
​https://bugs.webkit.org/show_bug.cgi?id=33143

Add some minimal additional help to land-diff and
pave the way for adding better help to all commands.

• Scripts/webkitpy/commands/download.py: Add small amount of additional help to land-diff
• Scripts/webkitpy/multicommandtool.py: support long_help
• Scripts/webkitpy/multicommandtool_unittest.py: test long_help

Location:

trunk/WebKitTools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/webkitpy/commands/download.py (modified) (1 diff)
• Scripts/webkitpy/multicommandtool.py (modified) (3 diffs)
• Scripts/webkitpy/multicommandtool_unittest.py (modified) (1 diff)

trunk/WebKitTools/ChangeLog

@@ +1 @@
+2010-01-04  Eric Seidel  <eric@webkit.org>
+
+        Reviewed by Adam Barth.
+
+        Need support for longer text in per-command help
+        https://bugs.webkit.org/show_bug.cgi?id=33143
+
+        Add some minimal additional help to land-diff and
+        pave the way for adding better help to all commands.
+
+        * Scripts/webkitpy/commands/download.py: Add small amount of additional help to land-diff
+        * Scripts/webkitpy/multicommandtool.py: support long_help
+        * Scripts/webkitpy/multicommandtool_unittest.py: test long_help
+
 2010-01-04  Adam Barth  <abarth@webkit.org>
 

trunk/WebKitTools/Scripts/webkitpy/commands/download.py

@@ -81 +81 @@
         steps.CloseBugForLandDiff,
     ]
+    long_help = """land-diff commits the current working copy diff (just as svn or git commit would).
+land-diff will build and run the tests before committing.
+If a bug id is provided, or one can be found in the ChangeLog land-diff will update the bug after committing."""
 
     def _prepare_state(self, options, args, tool):

trunk/WebKitTools/Scripts/webkitpy/multicommandtool.py

@@ -43 +43 @@
     name = None
     show_in_main_help = False
-    def __init__(self, help_text, argument_names=None, options=None, requires_local_commits=False):
+    def __init__(self, help_text, argument_names=None, options=None, long_help=None, requires_local_commits=False):
         self.help_text = help_text
+        self.long_help = long_help
         self.argument_names = argument_names
         self.required_arguments = self._parse_required_arguments(argument_names)
@@ -113 +114 @@
 
     def standalone_help(self):
-        help_text = self.name_with_arguments().ljust(len(self.name_with_arguments()) + 3) + self.help_text + "\n"
+        help_text = self.name_with_arguments().ljust(len(self.name_with_arguments()) + 3) + self.help_text + "\n\n"
+        if self.long_help:
+            help_text += "%s\n\n" % self.long_help
         help_text += self.option_parser.format_option_help(IndentedHelpFormatter())
         return help_text
@@ -132 +135 @@
     help_text = None
     argument_names = None
+    long_help = None
     def __init__(self, options=None, **kwargs):
-        Command.__init__(self, self.help_text, self.argument_names, options=options, **kwargs)
+        Command.__init__(self, self.help_text, self.argument_names, options=options, long_help=self.long_help, **kwargs)
 
 

trunk/WebKitTools/Scripts/webkitpy/multicommandtool_unittest.py

@@ -144 +144 @@
 
     def test_command_help(self):
-        command_with_options = TrivialCommand(options=[make_option("--my_option")])
+        command_with_options = TrivialCommand(options=[make_option("--my_option")], long_help="LONG HELP")
         tool = TrivialTool(commands=[command_with_options])
-        expected_subcommand_help = "trivial [options]   help text\nOptions:\n  --my_option=MY_OPTION\n\n"
+        expected_subcommand_help = "trivial [options]   help text\n\nLONG HELP\n\nOptions:\n  --my_option=MY_OPTION\n\n"
         self._assert_tool_main_outputs(tool, ["tool", "help", "trivial"], expected_subcommand_help)