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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




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

Brian Gernhardt <benji@xxxxxxxxxxxxxxxxxx> 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.

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
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux