Re: [PATCH] Documentation: mention ORIG_HEAD in am, merge, and rebase

From: Brian Gernhardt <benji@silverinsanity.com>
Date: Jul 8, 2008, 19:28 UTC
Message-ID: <4104DCD7-23D2-436E-8599-B2EB95EBD926@silverinsanity.com>
In-Reply-To: <7vmykstc1h.fsf@gitster.siamese.dyndns.org>

On Jul 8, 2008, at 3:23 PM, Junio C Hamano wrote:

Show 24 quoted lines

> Brian Gernhardt <benji@silverinsanity.com> writes:
>
>> diff --git a/Documentation/git-rebase.txt b/Documentation/git- 
>> rebase.txt
>> index f3459c7..37382c4 100644
>> --- a/Documentation/git-rebase.txt
>> +++ b/Documentation/git-rebase.txt
>> @@ -26,7 +26,8 @@ of commits that would be shown by `git log  
>> <upstream>..HEAD`.
>>
>> The current branch is reset to <upstream>, or <newbase> if the
>> --onto option was supplied.  This has the exact same effect as
>> -`git reset --hard <upstream>` (or <newbase>).
>> +`git reset --hard <upstream>` (or <newbase>).  This includes setting
>> +ORIG_HEAD to the pre-rebase tip of the branch.
>>
>> The commits that were previously saved into the temporary area are
>> then reapplied to the current branch, one by one, in order. Note that
>
> I found the above "This includes" part very hard to understand ---  
> it took
> me three re-reads to connect "This" and "the exact same effect".  Is  
> it
> just me?

I thought it perfectly easy to understand. ;-) But of course, I wrote it. I also wrote it immediately after reading the git-reset manual, which is why I phrased it that way. On a fresh read, it's less obvious.

Show 7 quoted lines

> I wonder if this is easier to understand:
>
>        The current branch is reset to <upstream>, or <newbase> if the
>        --onto option was supplied.  This has the exact same effect as
>        `git reset --hard <upstream>` (or <newbase>).  ORIG_HEAD is set
>        to point at the tip of the branch before this resetting  
> happens.

I might say "before the reset" instead of "before this resetting happens", as I find the latter slightly awkward. But that's a minor nit

~~ Brian