Mistake in git-reset documentation

Mistake in git-reset documentation

[Bojan Petrović]

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

Re: Mistake in git-reset documentation

[Krzysztof Mazur]

On Sat, Oct 27, 2012 at 01:21:18PM +0200, Bojan Petrović wrote:
> 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

Re: Mistake in git-reset documentation

[Bojan Petrović]

No need for that. Getting this patched will be enough. :) Thank you!

On 28 October 2012 09:36, Krzysztof Mazur <krzysiek@podlesie.net> wrote:
> On Sat, Oct 27, 2012 at 01:21:18PM +0200, Bojan Petrović wrote:
>> 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
>

Re: Mistake in git-reset documentation

[Jeff King]

On Sun, Oct 28, 2012 at 09:36:10AM +0100, Krzysztof Mazur wrote:

> -- >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>

I think this is sane, but...

>  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"?

-Peff

Re: Mistake in git-reset documentation

[Andreas Schwab]

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.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: Mistake in git-reset documentation

[Jeff King]

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

> 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

Re: Mistake in git-reset documentation

[Krzysztof Mazur]

On Sun, Oct 28, 2012 at 09:46:35AM -0400, Jeff King wrote:
> On Sun, Oct 28, 2012 at 02:39:49PM +0100, Andreas Schwab wrote:
> 
> > 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.
> 

The --mixed mode is also described as second mode, and saying that --mixed
is default earlier may save some time wasted on reading --soft
description.

There is also small inconsequence in what <mode> is, just "mixed" or
"--mixed".

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.

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

diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 117e374..978d8da 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,11 +43,11 @@ 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
-	must be one of the following:
+	the working tree depending on <mode>. If <mode> is omitted,
+	defaults to "--mixed". The <mode> must be one of the following:
 +
 --
 --soft::
-- 
1.8.0.47.g5b520ba

Re: Mistake in git-reset documentation

[Jeff King]

On Sun, Oct 28, 2012 at 03:13:27PM +0100, Krzysztof Mazur wrote:

> The --mixed mode is also described as second mode, and saying that --mixed
> is default earlier may save some time wasted on reading --soft
> description.
> 
> There is also small inconsequence in what <mode> is, just "mixed" or
> "--mixed".

Yeah, agreed on both.

> -- >8 --
> Subject: [PATCH] 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>

Thanks, this looks good to me.

-Peff