git-reset.txt: reset does not change files in target
authorMichael J Gruber <git@drmicha.warpmail.net>
Wed, 15 Sep 2010 20:47:40 +0000 (22:47 +0200)
committerJunio C Hamano <gitster@pobox.com>
Sat, 18 Sep 2010 22:14:16 +0000 (15:14 -0700)
git-reset obviously cannot change files in an existing commit. Make it
not sound as if it could: reset can change HEAD and, in that sense, can
change which state a file in HEAD is in.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-reset.txt

index 91bd2e90ec86fd6c098b514e86650870be6d7c11..e4437404f33c30e5d619c59940000867e4e45467 100644 (file)
@@ -294,8 +294,10 @@ In these tables, A, B, C and D are some different states of a
 file. For example, the first line of the first table means that if a
 file is in state A in the working tree, in state B in the index, in
 state C in HEAD and in state D in the target, then "git reset --soft
-target" will put the file in state A in the working tree, in state B
-in the index and in state D in HEAD.
+target" will leave the file in the working tree in state A and in the
+index in state B.  It resets (i.e. moves) the HEAD (i.e. the tip of
+the current branch, if you are on one) to "target" (which has the file
+in state D).
 
       working index HEAD target         working index HEAD
       ----------------------------------------------------