From: J. Bruce Fields <bfields@citi.umich.edu>
Date: Mon, 16 Apr 2007 04:37:16 +0000 (-0400)
Subject: user-manual: use detached head when rewriting history
X-Git-Tag: v1.5.1.2~23
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=25d9f3fa2d493bc769e39d18bf843cf11c235062;p=git.git

user-manual: use detached head when rewriting history

This is slightly simpler if we use a detached head.  And it's probably
good to have another example that uses this feature.

Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
Signed-off-by: Junio C Hamano <junkio@cox.net>
---

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 18d3bc729..9c4c41df5 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -504,6 +504,7 @@ $ cat .git/HEAD
 ref: refs/heads/master
 ------------------------------------------------
 
+[[detached-head]]
 Examining an old version without creating a new branch
 ------------------------------------------------------
 
@@ -2055,22 +2056,22 @@ $ git tag bad mywork~5
 
 (Either gitk or git-log may be useful for finding the commit.)
 
-Then check out a new branch at that commit, edit it, and rebase the rest of
-the series on top of it:
+Then check out that commit, edit it, and rebase the rest of the series
+on top of it (note that we could check out the commit on a temporary
+branch, but instead we're using a <<detached-head,detached head>>):
 
 -------------------------------------------------
-$ git checkout -b TMP bad
+$ git checkout bad
 $ # make changes here and update the index
 $ git commit --amend
-$ git rebase --onto TMP bad mywork
+$ git rebase --onto HEAD bad mywork
 -------------------------------------------------
 
-When you're done, you'll be left with mywork checked out, with the top patches
-on mywork reapplied on top of the modified commit you created in TMP.  You can
+When you're done, you'll be left with mywork checked out, with the top
+patches on mywork reapplied on top of your modified commit.  You can
 then clean up with
 
 -------------------------------------------------
-$ git branch -d TMP
 $ git tag -d bad
 -------------------------------------------------