diff options
| author | Elijah Newren <newren@gmail.com> | 2020-03-11 15:30:23 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-03-11 12:11:08 -0700 |
| commit | 120b1eb7314687375e0a229e102ffd194cae0e06 (patch) | |
| tree | 10563de5795b5b4c56a53aa988247e061c18e797 /Documentation/git-rebase.txt | |
| parent | 9a1b7474d6babad5fabed9a2926a57d875f3820b (diff) | |
| download | git-120b1eb7314687375e0a229e102ffd194cae0e06.tar.gz | |
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 <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-rebase.txt')
| -rw-r--r-- | Documentation/git-rebase.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 8c1f4b8268..f7a6033607 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -699,6 +699,16 @@ suffer from the same shortcoming. (See https://lore.kernel.org/git/20200207132152.GC2868@szeder.dev/ for details.) +Commit Rewording +~~~~~~~~~~~~~~~~ + +When a conflict occurs while rebasing, rebase stops and asks the user +to resolve. Since the user may need to make notable changes while +resolving conflicts, after conflicts are resolved and the user has run +`git rebase --continue`, the rebase should open an editor and ask the +user to update the commit message. The merge backend does this, while +the apply backend blindly applies the original commit message. + Miscellaneous differences ~~~~~~~~~~~~~~~~~~~~~~~~~ |