Re: [PATCH 4/5] revisions.txt: be explicit about commands writing 'ORIG_HEAD'

From: Philippe Blain <levraiphilippeblain@gmail.com>
Date: Jan 9, 2023, 14:00 UTC
Message-ID: <530a9dc9-dc16-fe26-954c-27daabf9e9bd@gmail.com>
In-Reply-To: <xmqqcz7p22x5.fsf@gitster.g>

Hi Junio,

Le 2023-01-07 à 21:08, Junio C Hamano a écrit :

Show 10 quoted lines

> "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 
>> -way, to record the position of the `HEAD` before their operation, so that
>> +way (`git am`, `git merge`, `git rebase`, `git reset`),
> 
> Let's not commit that these four will forever stay to be the
> commands that uses ORIG_HEAD.  Perhaps "(e.g. `git am`, ...)"?
> 
>> +to record the position of the `HEAD` before their operation, so that
>

I think I prefer being explicit in the documentation. It's easier for a user wanting to learn which commands write that pseudo-ref to have them all listed at the same place. If other commands learn to write it, we can update the list here.

That said, I can live with that patch being tweaked in the next iteration if people feel strongly about an explicit list.

Philippe.