Skip to content

Commit

Permalink
rebase -i: reword empty commit after fast-forward
Browse files Browse the repository at this point in the history
When rebase rewords a commit it picks the commit and then runs "git
commit --amend" to reword it. When the commit is picked the sequencer
tries to reuse existing commits by fast-forwarding if the parents are
unchanged. Rewording an empty commit that has been fast-forwarded fails
because "git commit --amend" is called without "--allow-empty". This
happens because when a commit is fast-forwarded the logic that checks
whether we should pass "--allow-empty" is skipped. Fix this by always
passing "--allow-empty" when rewording a commit. This is safe because we
are amending a commit that has already been picked so if it had become
empty when it was picked we'd have already returned an error.

As "git commit" will happily create empty merge commits without
"--allow-empty" we do not need to pass that flag when rewording merge
commits.

Signed-off-by: Phillip Wood <[email protected]>
  • Loading branch information
phillipwood committed Feb 7, 2025
1 parent 58b5801 commit f7675fc
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 3 deletions.
10 changes: 7 additions & 3 deletions sequencer.c
Original file line number Diff line number Diff line change
Expand Up @@ -2510,9 +2510,13 @@ static int do_pick_commit(struct repository *r,
*check_todo = !!(flags & EDIT_MSG);
if (!res && reword) {
fast_forward_edit:
res = run_git_commit(NULL, opts, EDIT_MSG |
VERIFY_MSG | AMEND_MSG |
(flags & ALLOW_EMPTY));
/*
* To reword we amend an existing commit so we
* want to use the same set of commit flags
* regardless of how we got here.
*/
flags = EDIT_MSG | VERIFY_MSG | AMEND_MSG | ALLOW_EMPTY;
res = run_git_commit(NULL, opts, flags);
*check_todo = 1;
}
}
Expand Down
14 changes: 14 additions & 0 deletions t/t3404-rebase-interactive.sh
Original file line number Diff line number Diff line change
Expand Up @@ -791,6 +791,20 @@ test_expect_success 'reword' '
grep "C changed" actual
'

test_expect_success 'reword fast-forwarded empty commit' '
git commit --allow-empty -m "empty commit" --only &&
(
set_fake_editor &&
FAKE_COMMIT_AMEND=edited FAKE_LINES="reword 1" \
git rebase -i HEAD^
) &&
test_commit_message HEAD <<-\EOF
empty commit
edited
EOF
'

test_expect_success 'no uncommitted changes when rewording and the todo list is reloaded' '
git checkout E &&
test_when_finished "git checkout @{-1}" &&
Expand Down
20 changes: 20 additions & 0 deletions t/t3430-rebase-merges.sh
Original file line number Diff line number Diff line change
Expand Up @@ -610,4 +610,24 @@ test_expect_success 'truncate label names' '
grep "label 0123456789-$" out
'

test_expect_success 'reword fast-forwarded empty merge commit' '
oid="$(git commit-tree -m "D1" -p A D^{tree})" &&
oid="$(git commit-tree -m "empty merge" -p D -p $oid D^{tree})" &&
write_script sequence-editor.sh <<-\EOF &&
sed /^merge/s/-C/-c/ "$1" >"$1.tmp"
mv "$1.tmp" "$1"
EOF
(
test_set_sequence_editor "$(pwd)/sequence-editor.sh" &&
GIT_EDITOR="echo edited >>" git rebase -i -r D $oid
) &&
test_commit_message HEAD <<-\EOF
empty merge
edited
EOF
'

test_done

0 comments on commit f7675fc

Please sign in to comment.