| Message ID | pull.818.v2.git.1610123298764.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v2] rebase -i: do leave commit message intact in fixup! chains | expand |
Johannes Schindelin via GitGitGadget <gitgitgadget@gmail.com> wrote: > > We actually need to actively suppress that clean-up lest a configured > `commit.cleanup` may interfere with what we want to do: leave the commit > message unchanged. > Changes since v1:> > * The fix now works even if commit.cleanup = commit Indeed. FWIW, this patch looks good to me. There is the lone remaining user of `CLEANUP_MSG` where we're handling the skipping of the final fixup in a chain and which is part of a larger block of code to handle various cases like that around `git rebase --skip`. I wrote some tests on top of your patch to see what happens and try to understand what's going on. The tests are below. I can't say I grok all that's going on in the implementation. By the time we're finalizing the commit message, it seems to me that we've lost track of which of the lines that look like comments are indeed comment lines added by us and which actually originate in the commit messages we're trying to rebase and which just happen to begin with a comment character. Maybe these tests could be simplified a bit, or de-boilerplated to some extent, but I think they do correctly demonstrate a similar bug that remains after your fix. What do you think? Are these test failures useful at all? Would it be an easy fix? In any case, I don't think the presence of these bugs need to hold up the fix you've posted here. The bugs look like they're related, but they are in different parts of the code (to the best of my understanding). FWIW, this diff is Signed-off-by me if you want to run with it. Maybe include some part of it that you agree with in your commit? (Yes, this diff mentions "master" several times. This file already mentions that branch name. You have a patch in seen to address that, but there would be a semantic conflict.) Martin diff --git a/t/t3415-rebase-autosquash.sh b/t/t3415-rebase-autosquash.sh index 88040bc435..f80318998f 100755 --- a/t/t3415-rebase-autosquash.sh +++ b/t/t3415-rebase-autosquash.sh @@ -448,4 +448,63 @@ test_expect_success 'fixup does not clean up commit message' ' test "$oneline" = "$(git show -s --format=%s)" ' +test_expect_failure 'fixup does not clean message (conflict in only fixup)' ' + test_when_finished "git checkout master" && + oneline="#ladder" && + echo version-1 >file && + git add file && + git commit -m version-1 && + git checkout -B fixup-topic HEAD^ && + # Now make two commits (oneline+fixup) that conflict + # in the fixup when we rebase them onto master. + git commit --allow-empty -m "$oneline" && + echo conflict >file && + git add file && + git commit --fixup HEAD && + test_must_fail git -c commit.cleanup=strip rebase -ki \ + --autosquash --onto=master HEAD~2 && + git rebase --skip && + test "$oneline" = "$(git show -s --format=%s)" +' + +test_expect_failure 'fixup does not clean message (conflict in non-last fixup)' ' + test_when_finished "git checkout master" && + oneline="#not-a-comment" && + echo version-2 >file && + git add file && + git commit -m version-2 && + git checkout -B fixup-topic HEAD^ && + # Now make three commits (oneline+fixup+fixup) that conflict + # in the first fixup when we rebase them onto master. + git commit --allow-empty -m "$oneline" && + echo conflict >file && + git add file && + git commit --fixup HEAD && + git commit --fixup HEAD --allow-empty && + test_must_fail git -c commit.cleanup=strip rebase -ki \ + --autosquash --onto=master HEAD~3 && + git rebase --skip && + test "$oneline" = "$(git show -s --format=%s)" +' + +test_expect_failure 'fixup does not clean message (conflict in last fixup)' ' + test_when_finished "git checkout master" && + oneline="#hash" && + echo version-3 >file && + git add file && + git commit -m version-3 && + git checkout -B fixup-topic HEAD^ && + # Now make three commits (oneline+fixup+fixup) that conflict + # in the second fixup when we rebase them onto master. + git commit --allow-empty -m "$oneline" && + git commit --fixup HEAD --allow-empty && + echo conflict >file && + git add file && + git commit --fixup HEAD && + test_must_fail git -c commit.cleanup=strip rebase -ki \ + --autosquash --onto=master HEAD~3 && + git rebase --skip && + test "$oneline" = "$(git show -s --format=%s)" +' + test_done
"Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com> writes: > We actually need to actively suppress that clean-up lest a configured > `commit.cleanup` may interfere with what we want to do: leave the commit > message unchanged. Good thinking. > Reported-by: Vojtěch Knyttl <vojtech@knyt.tl> > Helped-by: Martin Ågren <martin.agren@gmail.com> > Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> > --- > ... > diff --git a/sequencer.c b/sequencer.c > index 8909a467700..092e7b811f0 100644 > --- a/sequencer.c > +++ b/sequencer.c > @@ -943,6 +943,7 @@ N_("you have staged changes in your working tree\n" > #define CLEANUP_MSG (1<<3) > #define VERIFY_MSG (1<<4) > #define CREATE_ROOT_COMMIT (1<<5) > +#define VERBATIM_MSG (1<<6) It somewhat bothers me that these pretend to be orthogonal options that can be mixed and matched, but CLEANUP and VERBATIM do not make sense to be used at the same time. As long as we have some safety to ensure that both bits are not used at the same time, i.e.e.g. if ((flags & (CLEANUP_MSG|VERBATIM_MSG)) == (CLEANUP_MSG|VERBATIM_MSG)) BUG("cleanup and verbatim asked at the same time"); it would be OK, though. Thanks.
Hi Martin, On Tue, 12 Jan 2021, Martin Ågren wrote: > Johannes Schindelin via GitGitGadget <gitgitgadget@gmail.com> wrote: > > > > We actually need to actively suppress that clean-up lest a configured > > `commit.cleanup` may interfere with what we want to do: leave the commit > > message unchanged. > > > Changes since v1:> > > * The fix now works even if commit.cleanup = commit > > Indeed. FWIW, this patch looks good to me. > > There is the lone remaining user of `CLEANUP_MSG` where we're handling > the skipping of the final fixup in a chain and which is part of a larger > block of code to handle various cases like that around `git rebase > --skip`. I wrote some tests on top of your patch to see what happens and > try to understand what's going on. The tests are below. > > I can't say I grok all that's going on in the implementation. By the > time we're finalizing the commit message, it seems to me that we've lost > track of which of the lines that look like comments are indeed comment > lines added by us and which actually originate in the commit messages > we're trying to rebase and which just happen to begin with a comment > character. Indeed, we lost that information. For what it's worth, that's totally in line with how `--amend` works: git commit --allow-empty -m '#hash' git commit --allow-empty --amend This will interpret the `#hash` line as a comment. And since that's the case with `git commit`, I would contend that this is a different issue than the one I am trying to address in this patch series, and therefore should not be handled here (not even adding the `test_expect_failure` cases you generously provided). Ciao, Dscho
Hi Junio, On Tue, 12 Jan 2021, Junio C Hamano wrote: > "Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com> > writes: > > > We actually need to actively suppress that clean-up lest a configured > > `commit.cleanup` may interfere with what we want to do: leave the commit > > message unchanged. > > Good thinking. > > > Reported-by: Vojtěch Knyttl <vojtech@knyt.tl> > > Helped-by: Martin Ågren <martin.agren@gmail.com> > > Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> > > --- > > ... > > diff --git a/sequencer.c b/sequencer.c > > index 8909a467700..092e7b811f0 100644 > > --- a/sequencer.c > > +++ b/sequencer.c > > @@ -943,6 +943,7 @@ N_("you have staged changes in your working tree\n" > > #define CLEANUP_MSG (1<<3) > > #define VERIFY_MSG (1<<4) > > #define CREATE_ROOT_COMMIT (1<<5) > > +#define VERBATIM_MSG (1<<6) > > It somewhat bothers me that these pretend to be orthogonal options > that can be mixed and matched, but CLEANUP and VERBATIM do not make > sense to be used at the same time. As long as we have some safety > to ensure that both bits are not used at the same time, i.e.e.g. > > if ((flags & (CLEANUP_MSG|VERBATIM_MSG)) == (CLEANUP_MSG|VERBATIM_MSG)) > BUG("cleanup and verbatim asked at the same time"); > > it would be OK, though. I did something similar in spirit in the latest iteration. Thanks, Dscho
Johannes Schindelin <Johannes.Schindelin@gmx.de> writes: >> > #define CLEANUP_MSG (1<<3) >> > #define VERIFY_MSG (1<<4) >> > #define CREATE_ROOT_COMMIT (1<<5) >> > +#define VERBATIM_MSG (1<<6) >> >> It somewhat bothers me that these pretend to be orthogonal options >> that can be mixed and matched, but ... > > I did something similar in spirit in the latest iteration. Looks good. We do not expect for the BUG() to trigger as long as programmers are careful, but it is better to be careful. Another possibility would have been, as VERBATIM is what only we set programmatically when we do not want any clean-up to happen, make it override CLEANUP, but what is written in the updated patch is safer, I would think. Will queue v3. Thanks.
diff --git a/sequencer.c b/sequencer.c index 8909a467700..092e7b811f0 100644 --- a/sequencer.c +++ b/sequencer.c @@ -943,6 +943,7 @@ N_("you have staged changes in your working tree\n" #define CLEANUP_MSG (1<<3) #define VERIFY_MSG (1<<4) #define CREATE_ROOT_COMMIT (1<<5) +#define VERBATIM_MSG (1<<6) static int run_command_silent_on_success(struct child_process *cmd) { @@ -1012,6 +1013,8 @@ static int run_git_commit(const char *defmsg, strvec_pushl(&cmd.args, "-C", "HEAD", NULL); if ((flags & CLEANUP_MSG)) strvec_push(&cmd.args, "--cleanup=strip"); + if ((flags & VERBATIM_MSG)) + strvec_push(&cmd.args, "--cleanup=verbatim"); if ((flags & EDIT_MSG)) strvec_push(&cmd.args, "-e"); else if (!(flags & CLEANUP_MSG) && @@ -1454,6 +1457,8 @@ static int try_to_commit(struct repository *r, if (flags & CLEANUP_MSG) cleanup = COMMIT_MSG_CLEANUP_ALL; + else if (flags & VERBATIM_MSG) + cleanup = COMMIT_MSG_CLEANUP_NONE; else if ((opts->signoff || opts->record_origin) && !opts->explicit_cleanup) cleanup = COMMIT_MSG_CLEANUP_SPACE; @@ -2002,7 +2007,7 @@ static int do_pick_commit(struct repository *r, if (!final_fixup) msg_file = rebase_path_squash_msg(); else if (file_exists(rebase_path_fixup_msg())) { - flags |= CLEANUP_MSG; + flags |= VERBATIM_MSG; msg_file = rebase_path_fixup_msg(); } else { const char *dest = git_path_squash_msg(r); diff --git a/t/t3415-rebase-autosquash.sh b/t/t3415-rebase-autosquash.sh index 7bab6000dc7..88040bc4352 100755 --- a/t/t3415-rebase-autosquash.sh +++ b/t/t3415-rebase-autosquash.sh @@ -440,4 +440,12 @@ test_expect_success 'fixup a fixup' ' test XZWY = $(git show | tr -cd W-Z) ' +test_expect_success 'fixup does not clean up commit message' ' + oneline="#818" && + git commit --allow-empty -m "$oneline" && + git commit --fixup HEAD --allow-empty && + git -c commit.cleanup=strip rebase -ki --autosquash HEAD~2 && + test "$oneline" = "$(git show -s --format=%s)" +' + test_done