diff options
author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2022-10-13 18:39:03 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2022-10-13 19:32:55 +0300 |
commit | d4056dba1fbe7a0b1e36eab34b9a2ff8435f86a4 (patch) | |
tree | 56914eb4e7f0280043bc97fee9591d8444f9ff29 /builtin/stash.c | |
parent | 5af8b61cc36216bfde9d8b934fb8b657c2093aec (diff) |
doc txt & -h consistency: fix incorrect alternates syntax
Fix the incorrect "[-o | --option <argument>]" syntax, which should be
"[(-o | --option) <argument>]", we were previously claiming that only
the long option accepted the "<argument>", which isn't what we meant.
This syntax issue for "bugreport" originated in
238b439d698 (bugreport: add tool to generate debugging info,
2020-04-16), and for "diagnose" in 6783fd3cef0 (builtin/diagnose.c:
create 'git diagnose' builtin, 2022-08-12), which copied and adjusted
"bugreport" documentation and code.
In the case of "Documentation/git-stash.txt" and "builtin/stash.c"
this is not a "doc txt & -h consistency" change, as we're changing
both versions, doing so here makes a subsequent change smaller.
In that case fix the incorrect "[-o | --option <argument>]" syntax,
which should be "[(-o | --option) <argument>]", we were previously
claiming that only the long option accepted the "<argument>", which
isn't what we meant.
The "stash" issue has been with us in both the "-h" and *.txt versions
since bd514cada4b (stash: introduce 'git stash store', 2013-06-15).
We could claim that this isn't a syntax issue if a "vertical bar binds
tighter than option and its argument", but such a rule would change
e.g. this "cat-file" SYNOPSIS example to mean something we don't:
... [<rev>:<path|tree-ish> | --path=<path|tree-ish> <rev>]
We have various other examples where the post-image here is already
used, e.g. for "format-patch" ("-o"), "grep" ("-m"),
"submodule" ("set-branch -b") etc.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'builtin/stash.c')
-rw-r--r-- | builtin/stash.c | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/builtin/stash.c b/builtin/stash.c index 1ba24c1173..0fc359e9d3 100644 --- a/builtin/stash.c +++ b/builtin/stash.c @@ -29,7 +29,7 @@ static const char * const git_stash_usage[] = { N_("git stash branch <branchname> [<stash>]"), "git stash clear", N_("git stash [push [-p|--patch] [-S|--staged] [-k|--[no-]keep-index] [-q|--quiet]\n" - " [-u|--include-untracked] [-a|--all] [-m|--message <message>]\n" + " [-u|--include-untracked] [-a|--all] [(-m|--message) <message>]\n" " [--pathspec-from-file=<file> [--pathspec-file-nul]]\n" " [--] [<pathspec>...]]"), N_("git stash save [-p|--patch] [-S|--staged] [-k|--[no-]keep-index] [-q|--quiet]\n" @@ -73,13 +73,13 @@ static const char * const git_stash_clear_usage[] = { }; static const char * const git_stash_store_usage[] = { - N_("git stash store [-m|--message <message>] [-q|--quiet] <commit>"), + N_("git stash store [(-m|--message) <message>] [-q|--quiet] <commit>"), NULL }; static const char * const git_stash_push_usage[] = { N_("git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n" - " [-u|--include-untracked] [-a|--all] [-m|--message <message>]\n" + " [-u|--include-untracked] [-a|--all] [(-m|--message) <message>]\n" " [--] [<pathspec>...]]"), NULL }; |