]> git.ipfire.org Git - thirdparty/git.git/commit
git-rebase.txt: add a note about 'ORIG_HEAD' being overwritten
authorPhilippe Blain <levraiphilippeblain@gmail.com>
Tue, 10 Jan 2023 13:15:21 +0000 (13:15 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 13 Jan 2023 17:55:46 +0000 (09:55 -0800)
commitf1c9243fc5e5234ed00d3ecb71f2629c18d791ab
tree3c90c5811f97657ee84a6cde806c125814dbaac1
parentc6eec9cb3677fe91c887181c0a184cb30627fca2
git-rebase.txt: add a note about 'ORIG_HEAD' being overwritten

'ORIG_HEAD' is written at the start of the rebase, but is not guaranteed
to still point to the original branch tip at the end of the rebase.

Indeed, using other commands that write 'ORIG_HEAD' during the rebase,
like splitting a commit using 'git reset HEAD^', will lead to 'ORIG_HEAD'
being overwritten. This causes confusion for some users [1].

Add a note about that in the 'Description' section, and mention the more
robust alternative of using the branch's reflog.

[1] https://lore.kernel.org/git/28ebf03b-e8bb-3769-556b-c9db17e43dbb@gmail.com/T/#m827179c5adcfb504d67f76d03c8e6942b55e5ed0

Reported-by: Erik Cervin Edin <erik@cervined.in>
Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Acked-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-rebase.txt