undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

help: correct the usage string in -h and documentation

Browse Source 
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>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2021-09-10 13:28:42 +02:00 committed by Junio C Hamano
parent 8b7c11b866
commit b40845293b
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/git-help.txt
View File

@ -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
-----------

3
builtin/help.c
View File

@ -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
};