summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Michael J Gruber <git@drmicha.warpmail.net>2010-09-15 22:47:40 +0200
committerLibravatar Junio C Hamano <gitster@pobox.com>2010-09-18 15:14:16 -0700
commitaad8441483408119ea19d4cf9e5cccb4a7a3639d (patch)
tree816ce4cb38242848a06bd30cc0f52ed34caceb42
parentgit-reset.txt: clarify branch vs. branch head (diff)
downloadtgif-aad8441483408119ea19d4cf9e5cccb4a7a3639d.tar.xz
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>
-rw-r--r--Documentation/git-reset.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 91bd2e90ec..e4437404f3 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -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
----------------------------------------------------