diff options
| author |  Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2021-09-10 13:28:42 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2021-09-10 15:58:00 -0700 |
| commit | b40845293b57aa73d319aa1cec4184f114d8ce65 (patch) | |
| tree | ea13b24284b93976937f9fa35fe0995a899a0181 | |
| parent | The fifth batch (diff) | |
| download | tgif-b40845293b57aa73d319aa1cec4184f114d8ce65.tar.xz | |
help: correct the usage string in -h and documentation
Clarify the usage string in the documentation so we group e.g. -i and
--info, and add the missing short options to the "-h" output.
The alignment of the second line is off now, but will be fixed with
another series of mine[1]. In the meantime let's just assume that fix
will make it in eventually for the purposes of this patch, if it's
misaligned for a bit it doesn't matter much.
1. https://lore.kernel.org/git/cover-0.2-00000000000-20210901T110917Z-avarab@gmail.com
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-help.txt | 2 | ||||
| -rw-r--r-- | builtin/help.c | 3 |
2 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 44fe8860b3..568a0b606f 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'git help' [-a|--all [--[no-]verbose]] [-g|--guides] - [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE] + [[-i|--info] [-m|--man] [-w|--web]] [COMMAND|GUIDE] DESCRIPTION ----------- diff --git a/builtin/help.c b/builtin/help.c index b7eec06c3d..44ea2798cd 100644 --- a/builtin/help.c +++ b/builtin/help.c @@ -59,7 +59,8 @@ static struct option builtin_help_options[] = { }; static const char * const builtin_help_usage[] = { - N_("git help [--all] [--guides] [--man | --web | --info] [<command>]"), + N_("git help [-a|--all] [-g|--guides] [--[no-]verbose]]\n" + " [[-i|--info] [-m|--man] [-w|--web]] [<command>]"), NULL }; |