From: Phillip Wood <phillip.wood@talktalk.net>
To: Elijah Newren <newren@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH 2/2] git-rebase: error out when incompatible options passed
Date: Sun, 10 Jun 2018 20:40:24 +0100 [thread overview]
Message-ID: <cec770a8-28ee-d546-8c27-905d2fcdb0c8@talktalk.net> (raw)
In-Reply-To: <20180607050654.19663-2-newren@gmail.com>
On 07/06/18 06:06, Elijah Newren wrote:
> git rebase has three different types: am, merge, and interactive, all of
> which are implemented in terms of separate scripts. am builds on git-am,
> merge builds on git-merge-recursive, and interactive builds on
> git-cherry-pick. We make use of features in those lower-level commands in
> the different rebase types, but those features don't exist in all of the
> lower level commands so we have a range of incompatibilities. Previously,
> we just accepted nearly any argument and silently ignored whichever ones
> weren't implemented for the type of rebase specified. Change this so the
> incompatibilities are documented, included in the testsuite, and tested
> for at runtime with an appropriate error message shown.
I think this is a great improvement, it has always bothered me that
rebase silently ignored the am options when they're given with
interactive ones.
>
> Some exceptions I left out:
>
> * --merge and --interactive are technically incompatible since they are
> supposed to run different underlying scripts, but with a few small
> changes, --interactive can do everything that --merge can. In fact,
> I'll shortly be sending another patch to remove git-rebase--merge and
> reimplement it on top of git-rebase--interactive.
Excellent I've wondered about doing that but never got round to it. One
thing I was slightly concerned about was that someone maybe parsing the
output of git-rebase--merge and they'll get a nasty shock when that
output changes as a result of using the sequencer.
>
> * One could argue that --interactive and --quiet are incompatible since
> --interactive doesn't implement a --quiet mode (perhaps since
> cherry-pick itself does not implement one). However, the interactive
> mode is more quiet than the other modes in general with progress
> messages, so one could argue that it's already quiet.
>
> Signed-off-by: Elijah Newren <newren@gmail.com>
> ---
> Documentation/git-rebase.txt | 15 +++++++++++++--
> git-rebase.sh | 17 +++++++++++++++++
> t/t3422-rebase-incompatible-options.sh | 10 +++++-----
> 3 files changed, 35 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index 0e20a66e73..451252c173 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -243,6 +243,10 @@ leave out at most one of A and B, in which case it defaults to HEAD.
> --keep-empty::
> Keep the commits that do not change anything from its
> parents in the result.
> ++
> +This uses the `--interactive` machinery internally, and as such,
> +anything that is incompatible with --interactive is incompatible
> +with this option.
>
> --allow-empty-message::
> By default, rebasing commits with an empty message will fail.
> @@ -324,6 +328,8 @@ which makes little sense.
> and after each change. When fewer lines of surrounding
> context exist they all must match. By default no context is
> ever ignored.
> + Incompatible with the --merge and --interactive options, or
> + anything that implies those options or their machinery.
struct replay_opts has an allow_empty_message member so I'm not sure
that's true.
> -f::
> --force-rebase::
> @@ -355,13 +361,15 @@ default is `--no-fork-point`, otherwise the default is `--fork-point`.
> --whitespace=<option>::
> These flag are passed to the 'git apply' program
> (see linkgit:git-apply[1]) that applies the patch.
> - Incompatible with the --interactive option.
> + Incompatible with the --merge and --interactive options, or
> + anything that implies those options or their machinery.
I wonder if it is better just to list the incompatible options it might
be a bit long but it would be nicer for the user than them having to
work out which options imply --interactive.
> --committer-date-is-author-date::
> --ignore-date::
> These flags are passed to 'git am' to easily change the dates
> of the rebased commits (see linkgit:git-am[1]).
> - Incompatible with the --interactive option.
> + Incompatible with the --merge and --interactive options, or
> + anything that implies those options or their machinery.
>
> --signoff::
> Add a Signed-off-by: trailer to all the rebased commits. Note
> @@ -400,6 +408,9 @@ The `--rebase-merges` mode is similar in spirit to `--preserve-merges`, but
> in contrast to that option works well in interactive rebases: commits can be
> reordered, inserted and dropped at will.
> +
> +This uses the `--interactive` machinery internally, but it can be run
> +without an explicit `--interactive`.
> ++
Without more context it's hard to judge but I'm not sure this adds
anything useful
> It is currently only possible to recreate the merge commits using the
> `recursive` merge strategy; Different merge strategies can be used only via
> explicit `exec git merge -s <strategy> [...]` commands.
> diff --git a/git-rebase.sh b/git-rebase.sh
> index 40be59ecc4..f1dbecba18 100755
> --- a/git-rebase.sh
> +++ b/git-rebase.sh
> @@ -503,6 +503,23 @@ then
> git_format_patch_opt="$git_format_patch_opt --progress"
> fi
>
> +if test -n "$git_am_opt"; then
> + incompatible_opts=`echo "$git_am_opt" | sed -e 's/ -q//'`
I think the style guide recommends $() over ``
> + if test -n "$interactive_rebase"
> + then
> + if test -n "$incompatible_opts"
> + then
> + die "$(gettext "error: cannot combine interactive options (--interactive, --exec, --rebase-merges, --preserve-merges, --keep-empty, --root + --onto) with am options ($incompatible_opts)")"
> + fi
> + fi
> + if test -n "$do_merge"; then
> + if test -n "$incompatible_opts"
> + then
> + die "$(gettext "error: cannot combine merge options (--merge, --strategy, --strategy-option) with am options ($incompatible_opts)")"
> + fi
> + fi
> +fi
> +
> if test -n "$signoff"
> then
> test -n "$preserve_merges" &&
> diff --git a/t/t3422-rebase-incompatible-options.sh b/t/t3422-rebase-incompatible-options.sh
> index 04cdae921b..66a83363bf 100755
> --- a/t/t3422-rebase-incompatible-options.sh
> +++ b/t/t3422-rebase-incompatible-options.sh
> @@ -34,27 +34,27 @@ test_expect_success 'setup' '
> test_run_rebase () {
> opt=$1
> shift
> - test_expect_failure "$opt incompatible with --merge" "
> + test_expect_success "$opt incompatible with --merge" "
> git checkout B^0 &&
> test_must_fail git rebase $opt --merge A
> "
>
> - test_expect_failure "$opt incompatible with --strategy=ours" "
> + test_expect_success "$opt incompatible with --strategy=ours" "
> git checkout B^0 &&
> test_must_fail git rebase $opt --strategy=ours A
> "
>
> - test_expect_failure "$opt incompatible with --strategy-option=ours" "
> + test_expect_success "$opt incompatible with --strategy-option=ours" "
> git checkout B^0 &&
> test_must_fail git rebase $opt --strategy=ours A
> "
>
> - test_expect_failure "$opt incompatible with --interactive" "
> + test_expect_success "$opt incompatible with --interactive" "
> git checkout B^0 &&
> test_must_fail git rebase $opt --interactive A
> "
>
> - test_expect_failure "$opt incompatible with --exec" "
> + test_expect_success "$opt incompatible with --exec" "
> git checkout B^0 &&
> test_must_fail git rebase $opt --exec 'true' A
> "
>
next prev parent reply other threads:[~2018-06-10 19:40 UTC|newest]
Thread overview: 130+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-07 4:58 RFC: rebase inconsistency in 2.18 -- course of action? Elijah Newren
2018-06-07 5:04 ` [PATCH] t3401: add directory rename testcases for rebase and am Elijah Newren
2018-06-25 16:17 ` Elijah Newren
2018-06-07 5:05 ` [PATCH] apply: fix grammar error in comment Elijah Newren
2018-06-07 5:05 ` [PATCH] t5407: fix test to cover intended arguments Elijah Newren
2018-06-07 5:06 ` [PATCH] git-rebase--merge: modernize "git-$cmd" to "git $cmd" Elijah Newren
2018-06-07 5:24 ` Elijah Newren
2018-06-27 7:46 ` [PATCH v2] " Elijah Newren
2018-07-12 15:49 ` Johannes Schindelin
2018-07-13 16:13 ` Elijah Newren
2018-07-14 22:20 ` Johannes Schindelin
2018-06-07 5:06 ` [PATCH 1/2] t3422: new testcases for checking when incompatible options passed Elijah Newren
2018-06-07 5:06 ` [PATCH 2/2] git-rebase: error out " Elijah Newren
2018-06-10 19:40 ` Phillip Wood [this message]
2018-06-11 15:19 ` Elijah Newren
2018-06-11 15:59 ` Phillip Wood
2018-06-11 15:49 ` Elijah Newren
2018-06-12 9:45 ` Phillip Wood
2018-06-17 5:58 ` [RFC PATCH v2 0/7] Document/fix/warn about rebase incompatibilities and inconsistences Elijah Newren
2018-06-17 5:58 ` [RFC PATCH v2 1/7] git-rebase.txt: document incompatible options Elijah Newren
2018-06-17 15:38 ` Phillip Wood
2018-06-20 17:09 ` Elijah Newren
2018-06-17 17:15 ` Eric Sunshine
2018-06-20 17:10 ` Elijah Newren
2018-06-17 5:58 ` [RFC PATCH v2 2/7] git-rebase.sh: update help messages a bit Elijah Newren
2018-06-17 5:58 ` [RFC PATCH v2 3/7] t3422: new testcases for checking when incompatible options passed Elijah Newren
2018-06-17 5:58 ` [RFC PATCH v2 4/7] git-rebase: error out " Elijah Newren
2018-06-17 5:58 ` [RFC PATCH v2 5/7] git-rebase.txt: document behavioral inconsistencies between modes Elijah Newren
2018-06-17 5:58 ` [RFC PATCH v2 6/7] git-rebase.txt: address confusion between --no-ff vs --force-rebase Elijah Newren
2018-06-17 5:58 ` [RFC PATCH v2 7/7] git-rebase: make --allow-empty-message the default Elijah Newren
2018-06-17 15:30 ` Phillip Wood
2018-06-20 16:47 ` Elijah Newren
2018-06-17 15:41 ` [RFC PATCH v2 0/7] Document/fix/warn about rebase incompatibilities and inconsistences Phillip Wood
2018-06-21 15:00 ` [PATCH v3 0/7] Document/fix/warn about rebase incompatibilities and inconsistencies Elijah Newren
2018-06-21 15:00 ` [PATCH v3 1/7] git-rebase.txt: document incompatible options Elijah Newren
2018-06-21 19:47 ` Junio C Hamano
2018-06-21 20:33 ` Elijah Newren
2018-06-22 8:32 ` SZEDER Gábor
2018-06-21 15:00 ` [PATCH v3 2/7] git-rebase.sh: update help messages a bit Elijah Newren
2018-06-21 19:58 ` Junio C Hamano
2018-06-21 20:34 ` Elijah Newren
2018-06-21 15:00 ` [PATCH v3 3/7] t3422: new testcases for checking when incompatible options passed Elijah Newren
2018-06-21 20:04 ` Junio C Hamano
2018-06-21 20:37 ` Elijah Newren
2018-06-21 21:18 ` Eric Sunshine
2018-06-21 15:00 ` [PATCH v3 4/7] git-rebase: error out " Elijah Newren
2018-06-21 20:29 ` Junio C Hamano
2018-06-21 20:41 ` Elijah Newren
2018-06-21 15:00 ` [PATCH v3 5/7] git-rebase.txt: document behavioral inconsistencies between modes Elijah Newren
2018-06-21 20:44 ` Junio C Hamano
2018-06-21 21:25 ` Elijah Newren
2018-06-21 15:00 ` [PATCH v3 6/7] git-rebase.txt: address confusion between --no-ff vs --force-rebase Elijah Newren
2018-06-21 20:46 ` Junio C Hamano
2018-06-21 21:22 ` Elijah Newren
2018-06-21 15:00 ` [RFC PATCH v3 7/7] git-rebase: make --allow-empty-message the default Elijah Newren
2018-06-25 16:12 ` [PATCH v4 0/9] Document/fix/warn about rebase incompatibilities and inconsistencies Elijah Newren
2018-06-25 16:12 ` [PATCH v4 1/9] git-rebase.txt: document incompatible options Elijah Newren
2018-06-25 16:12 ` [PATCH v4 2/9] git-rebase.sh: update help messages a bit Elijah Newren
2018-06-25 16:12 ` [PATCH v4 3/9] t3422: new testcases for checking when incompatible options passed Elijah Newren
2018-06-26 18:17 ` Junio C Hamano
2018-06-27 6:50 ` Elijah Newren
2018-06-25 16:12 ` [PATCH v4 4/9] git-rebase: error out " Elijah Newren
2018-06-25 16:12 ` [PATCH v4 5/9] git-rebase.txt: address confusion between --no-ff vs --force-rebase Elijah Newren
2018-06-25 16:12 ` [PATCH v4 6/9] directory-rename-detection.txt: technical docs on abilities and limitations Elijah Newren
2018-06-25 16:12 ` [PATCH v4 7/9] git-rebase.txt: document behavioral differences between modes Elijah Newren
2018-06-25 16:12 ` [PATCH v4 8/9] t3401: add directory rename testcases for rebase and am Elijah Newren
2018-06-25 16:13 ` [RFC PATCH v4 9/9] git-rebase: make --allow-empty-message the default Elijah Newren
2018-06-27 7:23 ` [PATCH v5 0/9] Document/fix/warn about rebase incompatibilities and inconsistencies Elijah Newren
2018-06-27 7:23 ` [PATCH v5 1/9] git-rebase.txt: document incompatible options Elijah Newren
2018-06-27 7:23 ` [PATCH v5 2/9] git-rebase.sh: update help messages a bit Elijah Newren
2018-06-27 7:23 ` [PATCH v5 3/9] t3422: new testcases for checking when incompatible options passed Elijah Newren
2018-06-27 7:23 ` [PATCH v5 4/9] git-rebase: error out " Elijah Newren
2018-06-27 7:23 ` [PATCH v5 5/9] git-rebase.txt: address confusion between --no-ff vs --force-rebase Elijah Newren
2018-06-27 7:23 ` [PATCH v5 6/9] directory-rename-detection.txt: technical docs on abilities and limitations Elijah Newren
2018-06-27 7:23 ` [PATCH v5 7/9] git-rebase.txt: document behavioral differences between modes Elijah Newren
2018-06-27 7:23 ` [PATCH v5 8/9] t3401: add directory rename testcases for rebase and am Elijah Newren
2018-06-27 7:23 ` [RFC PATCH v5 9/9] git-rebase: make --allow-empty-message the default Elijah Newren
2018-09-12 2:42 ` 2.19.0 regression: leaving editor with empty commit message doesn't stop rebase [was: Re: [RFC PATCH v5 9/9] git-rebase: make --allow-empty-message the default] SZEDER Gábor
2018-09-12 6:21 ` Elijah Newren
2018-09-12 21:18 ` [PATCH] sequencer: fix --allow-empty-message behavior, make it smarter Elijah Newren
2018-09-13 20:24 ` Junio C Hamano
2018-06-29 13:20 ` [PATCH v5 0/9] Document/fix/warn about rebase incompatibilities and inconsistencies Phillip Wood
2018-06-07 5:07 ` [PATCH] git-rebase.sh: handle keep-empty like all other options Elijah Newren
2018-06-10 19:26 ` Phillip Wood
2018-06-11 14:42 ` Elijah Newren
2018-06-11 15:16 ` Phillip Wood
2018-06-11 16:08 ` Elijah Newren
2018-06-12 9:53 ` Phillip Wood
2018-06-07 5:08 ` [PATCH 1/2] t3418: add testcase showing problems with rebase -i and strategy options Elijah Newren
2018-06-07 5:08 ` [PATCH 2/2] Fix use of strategy options with interactive rebases Elijah Newren
2018-06-27 7:36 ` [PATCH v2 0/2] " Elijah Newren
2018-06-27 7:36 ` [PATCH v2 1/2] t3418: add testcase showing problems with rebase -i and strategy options Elijah Newren
2018-06-27 7:45 ` Eric Sunshine
2018-06-27 7:49 ` Elijah Newren
2018-06-27 16:54 ` Junio C Hamano
2018-06-27 17:27 ` Elijah Newren
2018-06-27 18:17 ` Johannes Sixt
2018-06-27 18:24 ` Eric Sunshine
2018-06-27 18:34 ` [PATCH v2 1/2] t3418: add testcase showing problems with rebase SZEDER Gábor
2018-06-27 19:20 ` [PATCH v2 1/2] t3418: add testcase showing problems with rebase -i and strategy options Junio C Hamano
2018-06-27 19:23 ` Junio C Hamano
2018-06-27 7:36 ` [PATCH v2 2/2] Fix use of strategy options with interactive rebases Elijah Newren
2018-06-27 15:48 ` [PATCH v3 0/2] " Elijah Newren
2018-06-27 15:48 ` [PATCH v3 1/2] t3418: add testcase showing problems with rebase -i and strategy options Elijah Newren
2018-06-27 18:28 ` SZEDER Gábor
2018-07-11 10:56 ` SZEDER Gábor
2018-07-11 19:12 ` Elijah Newren
2018-06-27 15:48 ` [PATCH v3 2/2] Fix use of strategy options with interactive rebases Elijah Newren
2018-07-12 15:41 ` Johannes Schindelin
2018-07-13 15:51 ` Elijah Newren
2018-06-07 17:13 ` [RFC PATCH 0/3] Send more rebases through interactive machinery Elijah Newren
2018-06-07 17:13 ` [RFC PATCH 1/3] git-rebase, sequencer: add a --quiet option for the " Elijah Newren
2018-06-09 21:45 ` Johannes Schindelin
2018-06-09 23:05 ` Elijah Newren
2018-06-07 17:13 ` [RFC PATCH 2/3] rebase: Implement --merge via git-rebase--interactive Elijah Newren
2018-06-09 22:04 ` Johannes Schindelin
2018-06-10 1:14 ` Elijah Newren
2018-06-11 9:54 ` Phillip Wood
2018-06-07 17:13 ` [RFC PATCH 3/3] git-rebase.sh: make git-rebase--interactive the default Elijah Newren
2018-06-09 22:11 ` Johannes Schindelin
2018-06-10 1:31 ` Elijah Newren
2018-06-17 21:44 ` Johannes Schindelin
2018-06-20 16:27 ` Elijah Newren
2018-06-21 10:57 ` Johannes Schindelin
2018-06-21 15:36 ` Elijah Newren
2019-01-21 15:55 ` Johannes Schindelin
2019-01-21 19:02 ` Elijah Newren
2019-01-22 15:37 ` Johannes Schindelin
2018-06-11 17:44 ` RFC: rebase inconsistency in 2.18 -- course of action? Junio C Hamano
2018-06-11 20:17 ` Elijah Newren
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cec770a8-28ee-d546-8c27-905d2fcdb0c8@talktalk.net \
--to=phillip.wood@talktalk.net \
--cc=git@vger.kernel.org \
--cc=newren@gmail.com \
--cc=phillip.wood@dunelm.org.uk \
/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.
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 NNTP newsgroup(s).