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

doc txt & -h consistency: use "<options>", not "<options>..."

Browse Source 
It's arguably more correct to say "[<option>...]" than either of these
forms, but the vast majority of our documentation uses the
"[<options>]" form to indicate an arbitrary number of options, let's
do the same in these cases, which were the odd ones out.

In the case of "mv" and "sparse-checkout" let's add the missing "[]"
to indicate that these are optional.

In the case of "t/helper/test-proc-receive.c" there is no *.txt
version, making it the only hunk in this commit that's not a "doc txt
& -h consistency" change.

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 2022-10-13 17:39:08 +02:00 committed by Junio C Hamano
parent 007512152e
commit 23a9235d52
5 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/git-mv.txt
View File

@ -9,7 +9,7 @@ git-mv - Move or rename a file, a directory, or a symlink
SYNOPSIS
--------
[verse]
'git mv' <options>... <args>...
'git mv' [<options>] <args>...
DESCRIPTION
-----------

2
Documentation/git-status.txt
View File

@ -9,7 +9,7 @@ git-status - Show the working tree status
SYNOPSIS
--------
[verse]
'git status' [<options>...] [--] [<pathspec>...]
'git status' [<options>] [--] [<pathspec>...]
DESCRIPTION
-----------

4
builtin/pack-objects.c
View File

@ -180,8 +180,8 @@ static inline void oe_set_delta_size(struct packing_data *pack,
#define SET_DELTA_SIBLING(obj, val) oe_set_delta_sibling(&to_pack, obj, val)
static const char *pack_usage[] = {
N_("git pack-objects --stdout [<options>...] [< <ref-list> | < <object-list>]"),
N_("git pack-objects [<options>...] <base-name> [< <ref-list> | < <object-list>]"),
N_("git pack-objects --stdout [<options>] [< <ref-list> | < <object-list>]"),
N_("git pack-objects [<options>] <base-name> [< <ref-list> | < <object-list>]"),
NULL
};

2
builtin/sparse-checkout.c
View File

@ -20,7 +20,7 @@
static const char *empty_base = "";
static char const * const builtin_sparse_checkout_usage[] = {
N_("git sparse-checkout (init | list | set | add | reapply | disable) <options>"),
N_("git sparse-checkout (init | list | set | add | reapply | disable) [<options>]"),
NULL
};

2
t/helper/test-proc-receive.c
View File

@ -6,7 +6,7 @@
#include "test-tool.h"
static const char *proc_receive_usage[] = {
"test-tool proc-receive [<options>...]",
"test-tool proc-receive [<options>]",
NULL
};