git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: Mistake in git-reset documentation

From
BPBojan Petrović <bojan85@gmail.com>
Date
Oct 28, 2012, 09:32 UTC
Message-ID
<CABPGWqoA9RKfAT5HPtL8q+cqVnNtY3m62FbnFupDfdNztjOhVA@mail.gmail.com>
In-Reply-To
<20121028083610.GA26374@shrek.podlesie.net>
No need for that. Getting this patched will be enough. :) Thank you!
On 28 October 2012 09:36, Krzysztof Mazur <krzysiek@podlesie.net> wrote:
Show 51 quoted lines
> 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
>
Previous: Krzysztof MazurNext: Jeff King
Message 3 of 8 in “Mistake in git-reset documentation”
  1. Bojan PetrovićOct 27, 2012
  2. Krzysztof MazurOct 28, 2012
  3. Bojan PetrovićOct 28, 2012
  4. Jeff KingOct 28, 2012
  5. Andreas SchwabOct 28, 2012
  6. Jeff KingOct 28, 2012
  7. Krzysztof MazurOct 28, 2012
  8. Jeff KingOct 29, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.