doc: git-reset: make "<mode>" optional
The git-reset's "<mode>" is an optional argument, however it was documented as required. The "<mode>" is documented as one of: --soft, --mixed, --hard, --merge or --keep, so "<mode>" should be used instead of "--<mode>". Signed-off-by: Krzysztof Mazur <krzysiek@podlesie.net> Signed-off-by: Jeff King <peff@peff.net>
Krzysztof Mazur committed
Oct 28, 2012 at 15:13 UTC
d505865be5c7d72abb74318940e8c4c52aa0db5f
1 file changed
+4
-4
Documentation/git-reset.txt
+4
-4
@@ -10,7 +10,7 @@ SYNOPSIS
10
[verse]
11
'git reset' [-q] [<commit>] [--] <paths>...
12
'git reset' (--patch | -p) [<commit>] [--] [<paths>...]
13
-'git reset' (--soft | --mixed | --hard | --merge | --keep) [-q] [<commit>]
13
+'git reset' [--soft | --mixed | --hard | --merge | --keep] [-q] [<commit>]
14
15
DESCRIPTION
16
-----------
@@ -43,11 +43,11 @@ This means that `git reset -p` is the opposite of `git add -p`, i.e.
43
you can use it to selectively reset hunks. See the ``Interactive Mode''
44
section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
45
46
-'git reset' --<mode> [<commit>]::
46
+'git reset' [<mode>] [<commit>]::
47
This form resets the current branch head to <commit> and
48
possibly updates the index (resetting it to the tree of <commit>) and
49
- the working tree depending on <mode>, which
50
- must be one of the following:
49
+ the working tree depending on <mode>. If <mode> is omitted,
50
+ defaults to "--mixed". The <mode> must be one of the following:
51
+
52
--
53
--soft::