[PATCHv2 2/6] git-reset.txt: reset does not change files in target

From: Michael J Gruber <git@drmicha.warpmail.net>
Date: Sep 15, 2010, 20:47 UTC
Message-ID: <248631a67b2f6bce911ccaeaf7b5762f57041e4f.1284582409.git.git@drmicha.warpmail.net>
In-Reply-To: <cover.1284365021.git.git@drmicha.warpmail.net>

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>
---
 Documentation/git-reset.txt |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 91bd2e9..e443740 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
       ----------------------------------------------------

-- 
1.7.3.rc1.215.g6997c