git-reset.txt: reset does not change files in target
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>
Michael J Gruber committed
Sep 15, 2010 at 22:47 UTC
aad8441483408119ea19d4cf9e5cccb4a7a3639d
1 file changed
+4
-2
Documentation/git-reset.txt
+4
-2
@@ -294,8 +294,10 @@ In these tables, A, B, C and D are some different states of a
294
file. For example, the first line of the first table means that if a
295
file is in state A in the working tree, in state B in the index, in
296
state C in HEAD and in state D in the target, then "git reset --soft
297
-target" will put the file in state A in the working tree, in state B
298
-in the index and in state D in HEAD.
297
+target" will leave the file in the working tree in state A and in the
298
+index in state B. It resets (i.e. moves) the HEAD (i.e. the tip of
299
+the current branch, if you are on one) to "target" (which has the file
300
+in state D).
301
302
working index HEAD target working index HEAD
303
----------------------------------------------------