summaryrefslogtreecommitdiff
path: root/builtin/describe.c
diff options
context:
space:
mode:
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>2022-10-13 15:39:13 (GMT)
committerJunio C Hamano <gitster@pobox.com>2022-10-13 16:32:56 (GMT)
commit8c9e292dc091e637eeb78fb0046c3572717b4a67 (patch)
treede4d63e2e6934fe3a2e1b20529554bdd0c184865 /builtin/describe.c
parent8f5f2f646a07772df12c3f7bf17eb62541042e41 (diff)
downloadgit-8c9e292dc091e637eeb78fb0046c3572717b4a67.zip
git-8c9e292dc091e637eeb78fb0046c3572717b4a67.tar.gz
git-8c9e292dc091e637eeb78fb0046c3572717b4a67.tar.bz2
doc txt & -h consistency: add missing options and labels
Fix various issues of SYNOPSIS and -h output syntax where: * Options such as --force were missing entirely * ...or the short option, such as -f * We said "opts" or "options", but could instead enumerate the (small) set of supported options * Options that were missing entirely (ls-remote's --sort=<key>) As we can specify "--sort" multiple times (it's backed by a string-list" it should really be "[(--sort=<key>)...]", which is what "git for-each-ref" lists it as, but let's leave that issue for a subsequent cleanup, and stop at making these consistent. Other "ref-filter.h" users share the same issue, e.g. "git-branch.txt". * For "verify-tag" and "verify-commit" we were missing the "--raw" option. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'builtin/describe.c')
-rw-r--r--builtin/describe.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/builtin/describe.c b/builtin/describe.c
index a76f1a1..98fb8af 100644
--- a/builtin/describe.c
+++ b/builtin/describe.c
@@ -23,8 +23,9 @@
define_commit_slab(commit_names, struct commit_name *);
static const char * const describe_usage[] = {
- N_("git describe [<options>] [<commit-ish>...]"),
- N_("git describe [<options>] --dirty"),
+ N_("git describe [--all] [--tags] [--contains] [--abbrev=<n>] [<commit-ish>...]"),
+ N_("git describe [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]"),
+ N_("git describe <blob>"),
NULL
};