summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael J Gruber <git@drmicha.warpmail.net>2010-09-15 22:47:41 +0200
committerJunio C Hamano <gitster@pobox.com>2010-09-18 15:14:19 -0700
commitcca5d0b04aa78c048239a0d5c36174f04d6d7f3a (patch)
tree728cc9203bef9843ea814f621841966f2c11ea49
parentaad8441483408119ea19d4cf9e5cccb4a7a3639d (diff)
downloadgit-cca5d0b04aa78c048239a0d5c36174f04d6d7f3a.tar.gz
git-reset.txt: reset --soft is not a no-op
Make it clearer that git reset --soft actually does something (changing HEAD). While it is mentioned in the previous paragraph already it can be easily overlooked otherwise. Also, git reset --soft does not look at the index nor the worktree, so there is no "good order" requirement. 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.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index e4437404f3..8762a0c6b9 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -42,10 +42,10 @@ linkgit:git-add[1]).
+
--
--soft::
- Does not touch the index file nor the working tree at all, but
- requires them to be in a good order. This leaves all your changed
- files "Changes to be committed", as 'git status' would
- put it.
+ Does not touch the index file nor the working tree at all (but
+ resets the head to <commit>, just like all modes do). This leaves
+ all your changed files "Changes to be committed", as 'git status'
+ would put it.
--mixed::
Resets the index but not the working tree (i.e., the changed files