Re: Mistake in git-reset documentation

From: Jeff King <peff@peff.net>
Date: Oct 28, 2012, 13:46 UTC
Message-ID: <20121028134635.GA25519@sigill.intra.peff.net>
In-Reply-To: <m2zk36hg0q.fsf@igel.home>

On Sun, Oct 28, 2012 at 02:39:49PM +0100, Andreas Schwab wrote:

Show 20 quoted lines

> Jeff King <peff@peff.net> writes:
> 
> > On Sun, Oct 28, 2012 at 09:36:10AM +0100, Krzysztof Mazur wrote:
> >
> >>  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
> >
> > Should we say something like "if --<mode> is omitted, defaults to
> > "--mixed"?
> 
> Under --mixed it already says "This is the default action", though.

I know, but that is somewhat buried for somebody who is seeing that the "--<mode>" bit is optional and wondering what it means to omit it.

-Peff