Re: Mistake in git-reset documentation
- From
- Krzysztof Mazur <krzysiek@podlesie.net>
- Date
- Oct 28, 2012, 08:36 UTC
- Message-ID
- <20121028083610.GA26374@shrek.podlesie.net>
- In-Reply-To
- <CABPGWqr7=Rq4qS7yP09t2vMBUJ98NFTSmHUUgMzUQ5=WVrjfqg@mail.gmail.com>
On Sat, Oct 27, 2012 at 01:21:18PM +0200, Bojan Petrović wrote:
Show 7 quoted lines
> None of the three forms of git-reset accept: "git reset" which is the > equivalent of "git reset -mixed". > > Square brackets should be used instead of parentheses for "--soft | > --mixed | --hard | --merge | --keep". > > Bojan
Square brackets are also missing in "'git reset' --<mode> [<commit>]".
Bojan, do you want to add a Reported-by line with your name?
Krzysiek
-- >8 -- Subject: [PATCH] doc: git-reset: make "--<mode>" optional
The git-reset's "--<mode>" is an optional argument, however it was documented as required.
Signed-off-by: Krzysztof Mazur <krzysiek@podlesie.net> --- Documentation/git-reset.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index 117e374..1f95292 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'git reset' [-q] [<commit>] [--] <paths>... 'git reset' (--patch | -p) [<commit>] [--] [<paths>...] -'git reset' (--soft | --mixed | --hard | --merge | --keep) [-q] [<commit>] +'git reset' [--soft | --mixed | --hard | --merge | --keep] [-q] [<commit>] DESCRIPTION ----------- @@ -43,7 +43,7 @@ This means that `git reset -p` is the opposite of `git add -p`, i.e. you can use it to selectively reset hunks. See the ``Interactive Mode'' section of linkgit:git-add[1] to learn how to operate the `--patch` mode. -'git reset' --<mode> [<commit>]:: +'git reset' [--<mode>] [<commit>]:: This form resets the current branch head to <commit> and possibly updates the index (resetting it to the tree of <commit>) and the working tree depending on <mode>, which
-- 1.8.0.46.gd11dae0