Skip to content

Commit 120b1eb

Browse files
newrengitster
authored andcommitted
git-rebase.txt: highlight backend differences with commit rewording
As noted by Junio: Back when "git am" was written, it was not considered a bug that the "git am --resolved" option did not offer the user a chance to update the log message to match the adjustment of the code the user made, but honestly, I'd have to say that it is a bug in "git am" in that over time it wasn't adjusted to the new world order where we encourage users to describe what they did when the automation hiccuped by opening an editor. These days, even when automation worked well (e.g. a clean auto-merge with "git merge"), we open an editor. The world has changed, and so should the expectations. Junio also suggested providing a workaround such as allowing --no-edit together with git rebase --continue, but that should probably be done in a patch after the git-2.26.0 release. For now, just document the known difference in the Behavioral Differences section. Signed-off-by: Elijah Newren <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 9a1b747 commit 120b1eb

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Documentation/git-rebase.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -699,6 +699,16 @@ suffer from the same shortcoming. (See
699699
https://lore.kernel.org/git/[email protected]/ for
700700
details.)
701701

702+
Commit Rewording
703+
~~~~~~~~~~~~~~~~
704+
705+
When a conflict occurs while rebasing, rebase stops and asks the user
706+
to resolve. Since the user may need to make notable changes while
707+
resolving conflicts, after conflicts are resolved and the user has run
708+
`git rebase --continue`, the rebase should open an editor and ask the
709+
user to update the commit message. The merge backend does this, while
710+
the apply backend blindly applies the original commit message.
711+
702712
Miscellaneous differences
703713
~~~~~~~~~~~~~~~~~~~~~~~~~
704714

0 commit comments

Comments
 (0)