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>
Ævar Arnfjörð Bjarmason committed
Sep 10, 2021 at 13:28 UTC
b40845293b57aa73d319aa1cec4184f114d8ce65
2 files changed
+3
-2
Documentation/git-help.txt
+1
-1
@@ -9,7 +9,7 @@ SYNOPSIS
9
--------
10
[verse]
11
'git help' [-a|--all [--[no-]verbose]] [-g|--guides]
12
- [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
12
+ [[-i|--info] [-m|--man] [-w|--web]] [COMMAND|GUIDE]
13
14
DESCRIPTION
15
-----------
builtin/help.c
+2
-1
@@ -59,7 +59,8 @@ static struct option builtin_help_options[] = {
59
};
60
61
static const char * const builtin_help_usage[] = {
62
- N_("git help [--all] [--guides] [--man | --web | --info] [<command>]"),
62
+ N_("git help [-a|--all] [-g|--guides] [--[no-]verbose]]\n"
63
+ " [[-i|--info] [-m|--man] [-w|--web]] [<command>]"),
64
NULL
65
};
66