[PATCH 1/2 v2] rebase -i: clarify in-editor documentation of "exec"
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- Jan 21, 2011, 00:36 UTC
- Message-ID
- <20110121003624.GB23139@burratino>
- In-Reply-To
- <7vy66fqoji.fsf@alter.siamese.dyndns.org>
The hints in the current "instruction sheet" template look like so:
# Rebase 3f14246..a1d7e01 onto 3f14246 # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like "squash", but discard this commit's log message # x <cmd>, exec <cmd> = Run a shell command <cmd>, and stop if it fails # # If you remove a line here THAT COMMIT WILL BE LOST. # However, if you remove everything, the rebase will be aborted. #
This does not make it clear that the format of each line is
<insn> <commit id> <explanatory text that will be printed>
but the reader will probably infer that from the automatically generated pick examples above it.
What about the "exec" instruction? By analogy, I might imagine that the format of that line is "exec <command> <explanatory text>", and the "x <cmd>" hint does not address that question (at first I read it as taking an argument <cmd> that is the name of a shell). Meanwhile, the mention of <cmd> makes the hints harder to scan as a table.
So remove the <cmd> and add some words to remind the reader that "exec" runs a command named by the rest of the line. To make room, it is left to the manpage to explain that that command is run using $SHELL and that nonzero status from that command will pause the rebase.
Wording from Junio.
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> --- Junio C Hamano wrote:
> If we wanted to be more helpful, perhaps s/(see below)/specified on the > rest of the line/ should be sufficient without adding extra lines.
Sounds good.
git-rebase--interactive.sh | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/git-rebase--interactive.sh b/git-rebase--interactive.sh index a5ffd9a..a18c9b1 100755 --- a/git-rebase--interactive.sh +++ b/git-rebase--interactive.sh @@ -1021,7 +1021,7 @@ first and then run 'git rebase --continue' again." # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like "squash", but discard this commit's log message -# x <cmd>, exec <cmd> = Run a shell command <cmd>, and stop if it fails +# x, exec = run command specified on the rest of the line # # If you remove a line here THAT COMMIT WILL BE LOST. # However, if you remove everything, the rebase will be aborted.
-- 1.7.4.rc2