From b52f3780e10a4657224f6988316bdbfef9ec2dda Mon Sep 17 00:00:00 2001 Message-Id: From: Mark Wooding Date: Sat, 6 Oct 2007 10:35:44 +0200 Subject: [PATCH] Fix up the help text for "stg edit" MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Organization: Straylight/Edgeware From: Karl Hasselström The sentence structure was strange, and the example format was somewhat misleading (StGit doesn't care about sign-off lines, for example). Signed-off-by: Karl Hasselström --- stgit/commands/edit.py | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/stgit/commands/edit.py b/stgit/commands/edit.py index 63c710b..e968e25 100644 --- a/stgit/commands/edit.py +++ b/stgit/commands/edit.py @@ -30,19 +30,25 @@ from stgit import stack, git help = 'edit a patch description or diff' usage = """%prog [options] [] -Edit the given patch (defaulting to the current one) description, -author information or its diff (if the '--diff' option is -passed). Without any other option, the command invokes the editor with -the patch description and diff in the form below: +Edit the description and author information of the given patch (or the +current patch if no patch name was given). With --diff, also edit the +diff. - Subject line +The editor is invoked with the following contents: - From: author information + Patch short description + + From: A U Thor Date: creation date - Patch description + Patch long description + +If --diff was specified, the diff appears at the bottom, after a +separator: + + --- - Signed-off-by: author + Diff text Command-line options can be used to modify specific information without invoking the editor. @@ -54,7 +60,7 @@ these files using the '--file' and '--diff' options. """ options = [make_option('-d', '--diff', - help = 'allow the editing of the patch diff', + help = 'edit the patch diff', action = 'store_true'), make_option('-f', '--file', help = 'use FILE instead of invoking the editor'), -- [mdw]