From: Jonathan Nieder <jrnieder@gmail.com>
To: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>
Cc: git@vger.kernel.org, gitster@pobox.com,
Kevin Ballard <kevin@sb.org>, Yann Dirson <dirson@bertin.fr>,
Eric Raible <raible@nextest.com>
Subject: Re: [PATCH 1/2] rebase -i: reword in-editor documentation of "exec"
Date: Thu, 20 Jan 2011 14:09:49 -0600 [thread overview]
Message-ID: <20110120200949.GB11702@burratino> (raw)
In-Reply-To: <vpq39otrvmk.fsf@bauges.imag.fr>
Matthieu Moy wrote:
> Jonathan Nieder <jrnieder@gmail.com> writes:
>> -# x <cmd>, exec <cmd> = Run a shell command <cmd>, and stop if it fails
>> +# x, exec = run command using shell, and stop if it fails
>
> I don't think this is a good change to remove the <cmd> part. All
> other commands are used with
>
> <command> <sha1> <subject line>
>
> and I don't think the user would be able to guess that exec is
> different without a hint.
>
> If the problem is the wording of the sentence that may imply that
> <cmd> should be the shell itself, then why not
Yes, sorry, I combined two problems into a single patch. That was a
mistake. The current cheat sheet says:
# 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
<instruction> <commit id> <explanatory text that will be printed>
but the reader will probably infer that from the automatically
generated pick examples above.
What about the "exec" instruction? By analogy, I might imagine that
the format of that line is
exec <command> <explanatory text that will be printed>
So the "<cmd>" does not address that question for me. It does succeed
in clarifying that "a shell command" does not mean an arbitrary shell
command but a user-specified one.
Meanwhile, it makes the cheat sheet harder to visually scan as a table
i, instruction = action performed by instruction
Maybe "exec" should be explained outside this table? For example,
maybe something along the lines of
x, exec = run an arbitrary command (see below)
A line of the form "exec <command>" will run <command> using your
shell and stop for investigation or amending if the command fails.
If you remove a line here, THAT COMMIT WILL BE LOST.
However, if you remove everything, the rebase will be aborted.
next prev parent reply other threads:[~2011-01-20 20:10 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-10 13:08 Black smoke from git rebase -i exec Ævar Arnfjörð Bjarmason
2010-08-10 13:37 ` Matthieu Moy
2010-08-10 13:57 ` Ævar Arnfjörð Bjarmason
2010-08-10 14:12 ` Johannes Sixt
2010-08-10 14:16 ` Ævar Arnfjörð Bjarmason
2010-08-10 15:05 ` Matthieu Moy
2010-08-10 15:17 ` [PATCH 1/2 (fix broken test)] rebase -i: add exec command to launch a shell command Matthieu Moy
2010-08-11 18:31 ` Junio C Hamano
2010-08-12 7:47 ` Matthieu Moy
2011-01-16 1:59 ` [PATCH 0/2] rebase -i: in-editor documentation nits Jonathan Nieder
2011-01-16 2:01 ` [PATCH 1/2] rebase -i: reword in-editor documentation of "exec" Jonathan Nieder
2011-01-16 10:27 ` Matthieu Moy
2011-01-18 15:05 ` Junio C Hamano
2011-01-20 20:09 ` Jonathan Nieder [this message]
2011-01-20 20:59 ` Junio C Hamano
2011-01-21 0:36 ` [PATCH 1/2 v2] rebase -i: clarify " Jonathan Nieder
2011-01-21 6:59 ` Matthieu Moy
2011-01-21 7:47 ` Jonathan Nieder
2011-01-21 10:43 ` Matthieu Moy
2011-01-16 2:02 ` [PATCH 2/2] rebase -i: explain how to discard all commits Jonathan Nieder
2011-01-20 19:39 ` [PATCH 2/2] " Nicolas Sebrecht
2011-01-20 19:57 ` Jonathan Nieder
2011-01-20 20:08 ` Nicolas Sebrecht
2011-01-20 20:34 ` Thomas Rast
2011-01-20 21:28 ` Junio C Hamano
2011-01-21 7:04 ` Johannes Schindelin
2011-01-21 7:37 ` [PATCH] Documentation: suggest "reset --keep" to undo a commit Jonathan Nieder
2011-01-21 17:34 ` Junio C Hamano
2011-01-21 19:14 ` Jonathan Nieder
2011-01-21 20:28 ` Junio C Hamano
2011-01-21 16:51 ` [PATCH 2/2] Re: rebase -i: explain how to discard all commits Junio C Hamano
2011-01-21 17:05 ` Matthieu Moy
2011-01-21 17:57 ` Joshua Jensen
2011-01-21 18:37 ` [PATCH] Documentation: do not treat reset --keep as a special case Jonathan Nieder
2011-01-21 20:35 ` Junio C Hamano
2011-01-26 7:33 ` [PATCH 2/2] Re: rebase -i: explain how to discard all commits Jay Soffian
2011-01-23 20:10 ` Johannes Schindelin
2010-08-10 15:17 ` [PATCH 2/2] test-lib: user-friendly alternatives to test [-d|-f|-e] Matthieu Moy
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20110120200949.GB11702@burratino \
--to=jrnieder@gmail.com \
--cc=Matthieu.Moy@grenoble-inp.fr \
--cc=dirson@bertin.fr \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=kevin@sb.org \
--cc=raible@nextest.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).