From: Quentin Bernet <quentin.bernet@bluewin•ch>
To: "D. Ben Knoble" <ben.knoble@gmail•com>,
Quentin Bernet via GitGitGadget <gitgitgadget@gmail•com>
Cc: git@vger•kernel.org
Subject: Re: [PATCH] docs: fix git stash grammar
Date: Fri, 27 Mar 2026 09:25:09 +0100 [thread overview]
Message-ID: <ce083a4a-321d-4c29-af04-decfab33d237@bluewin.ch> (raw)
In-Reply-To: <CALnO6CD-5NBUoooMD+pQAxeyXCjkZ3Za6LJrLrJN57Nrz03xBw@mail.gmail.com>
This seems to be describing more the content of the patch than the
intention behind it, what about:
The grammar for "git stash" does not contain valid combinations such as
"git stash --include-untracked"; fix it
On 3/26/26 17:17, D. Ben Knoble wrote:
> On Thu, Mar 26, 2026 at 8:46 AM Quentin Bernet via GitGitGadget
> <gitgitgadget@gmail•com> wrote:
>> From: Quentin Bernet <quentin.bernet@bluewin•ch>
>>
>> Grammar incorrectly did not include `git stash -m`
>> and other valid `git stash push` flags
> Typically commits for Git describe
> - the current situation (present tense)
> - commands to make the code better
>
> In this case, something like
>
> The grammar for "git stash" is incorrectly bracketed; fix it.
>
> ?
>
>> Signed-off-by: Quentin Bernet <quentin.bernet@bluewin•ch>
>> ---
>> Fix git stash grammar
>>
>> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2255%2FSporarum%2Fpatch-1-v1
>> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2255/Sporarum/patch-1-v1
>> Pull-Request: https://github.com/git/git/pull/2255
>>
>> Documentation/git-stash.adoc | 4 ++--
>> builtin/stash.c | 4 ++--
>> 2 files changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/Documentation/git-stash.adoc b/Documentation/git-stash.adoc
>> index 235d57ddd8..41086c21a4 100644
>> --- a/Documentation/git-stash.adoc
>> +++ b/Documentation/git-stash.adoc
>> @@ -14,10 +14,10 @@ git stash drop [-q | --quiet] [<stash>]
>> git stash pop [--index] [-q | --quiet] [<stash>]
>> git stash apply [--index] [-q | --quiet] [<stash>]
>> git stash branch <branchname> [<stash>]
>> -git stash [push [-p | --patch] [-S | --staged] [-k | --[no-]keep-index] [-q | --quiet]
>> +git stash [push] [-p | --patch] [-S | --staged] [-k | --[no-]keep-index] [-q | --quiet]
>> [-u | --include-untracked] [-a | --all] [(-m | --message) <message>]
>> [--pathspec-from-file=<file> [--pathspec-file-nul]]
>> - [--] [<pathspec>...]]
>> + [--] [<pathspec>...]
>> git stash save [-p | --patch] [-S | --staged] [-k | --[no-]keep-index] [-q | --quiet]
>> [-u | --include-untracked] [-a | --all] [<message>]
>> git stash clear
>> diff --git a/builtin/stash.c b/builtin/stash.c
>> index 95c5005b0b..0d27b2fb1f 100644
>> --- a/builtin/stash.c
>> +++ b/builtin/stash.c
>> @@ -50,10 +50,10 @@
>> #define BUILTIN_STASH_STORE_USAGE \
>> N_("git stash store [(-m | --message) <message>] [-q | --quiet] <commit>")
>> #define BUILTIN_STASH_PUSH_USAGE \
>> - N_("git stash [push [-p | --patch] [-S | --staged] [-k | --[no-]keep-index] [-q | --quiet]\n" \
>> + N_("git stash [push] [-p | --patch] [-S | --staged] [-k | --[no-]keep-index] [-q | --quiet]\n" \
>> " [-u | --include-untracked] [-a | --all] [(-m | --message) <message>]\n" \
>> " [--pathspec-from-file=<file> [--pathspec-file-nul]]\n" \
>> - " [--] [<pathspec>...]]")
>> + " [--] [<pathspec>...]")
>> #define BUILTIN_STASH_SAVE_USAGE \
>> N_("git stash save [-p | --patch] [-S | --staged] [-k | --[no-]keep-index] [-q | --quiet]\n" \
>> " [-u | --include-untracked] [-a | --all] [<message>]")
>>
>> base-commit: ce74208c2fa13943fffa58f168ac27a76d0eb789
>> --
>> gitgitgadget
> Now, _is_ the grammar bracketed wrong? "git help stash" says
>
> For quickly making a snapshot, you can omit "push". In this mode,
> non-option arguments are not allowed to prevent a misspelled
> subcommand from making an unwanted stash entry. The two exceptions
> to this are stash -p which acts as alias for stash push -p and
> pathspec elements, which are allowed after a double hyphen -- for
> disambiguation.
>
> So _if_ you want to provide options (other than "-p"), the "push" is
> required. I think the existing brackets indicate that.
>
next prev parent reply other threads:[~2026-03-27 8:27 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-26 12:45 [PATCH] docs: fix git stash grammar Quentin Bernet via GitGitGadget
2026-03-26 16:17 ` D. Ben Knoble
2026-03-27 0:04 ` Mirko Faina
2026-03-27 15:58 ` Junio C Hamano
2026-03-27 16:28 ` Quentin Bernet
2026-03-27 16:53 ` Junio C Hamano
2026-03-27 16:58 ` Quentin Bernet
2026-03-27 17:16 ` Junio C Hamano
2026-03-27 17:36 ` Quentin Bernet
2026-03-27 17:45 ` Junio C Hamano
2026-03-27 16:47 ` Ben Knoble
2026-03-27 8:25 ` Quentin Bernet [this message]
2026-03-30 13:24 ` [PATCH v2] docs: fix "git stash [push]" documentation Quentin Bernet via GitGitGadget
2026-03-30 15:18 ` Junio C Hamano
2026-03-30 17:19 ` Quentin Bernet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ce083a4a-321d-4c29-af04-decfab33d237@bluewin.ch \
--to=quentin.bernet@bluewin$(echo .)ch \
--cc=ben.knoble@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitgitgadget@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox