From: D. Ben Knoble Date: Thu, 26 Mar 2026 16:17:46 GMT Subject: Re: [PATCH] docs: fix git stash grammar Message-ID: In-Reply-To: On Thu, Mar 26, 2026 at 8:46 AM Quentin Bernet via GitGitGadget wrote: > > From: Quentin Bernet > > 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 > --- > 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] [] > git stash pop [--index] [-q | --quiet] [] > git stash apply [--index] [-q | --quiet] [] > git stash branch [] > -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) ] > [--pathspec-from-file= [--pathspec-file-nul]] > - [--] [...]] > + [--] [...] > git stash save [-p | --patch] [-S | --staged] [-k | --[no-]keep-index] [-q | --quiet] > [-u | --include-untracked] [-a | --all] [] > 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) ] [-q | --quiet] ") > #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) ]\n" \ > " [--pathspec-from-file= [--pathspec-file-nul]]\n" \ > - " [--] [...]]") > + " [--] [...]") > #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] []") > > 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. -- D. Ben Knoble