doc txt & -h consistency: use "<options>", not "<options>..."
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>
Ævar Arnfjörð Bjarmason committed
Oct 13, 2022 at 17:39 UTC
23a9235d523f3e8e7dd9becee23a15559b4e5a32
5 files changed
+6
-6
Documentation/git-mv.txt
+1
-1
@@ -9,7 +9,7 @@ git-mv - Move or rename a file, a directory, or a symlink
9
SYNOPSIS
10
--------
11
[verse]
12
-'git mv' <options>... <args>...
12
+'git mv' [<options>] <args>...
13
14
DESCRIPTION
15
-----------
Documentation/git-status.txt
+1
-1
@@ -9,7 +9,7 @@ git-status - Show the working tree status
9
SYNOPSIS
10
--------
11
[verse]
12
-'git status' [<options>...] [--] [<pathspec>...]
12
+'git status' [<options>] [--] [<pathspec>...]
13
14
DESCRIPTION
15
-----------
builtin/pack-objects.c
+2
-2
@@ -180,8 +180,8 @@ static inline void oe_set_delta_size(struct packing_data *pack,
180
#define SET_DELTA_SIBLING(obj, val) oe_set_delta_sibling(&to_pack, obj, val)
181
182
static const char *pack_usage[] = {
183
- N_("git pack-objects --stdout [<options>...] [< <ref-list> | < <object-list>]"),
184
- N_("git pack-objects [<options>...] <base-name> [< <ref-list> | < <object-list>]"),
183
+ N_("git pack-objects --stdout [<options>] [< <ref-list> | < <object-list>]"),
184
+ N_("git pack-objects [<options>] <base-name> [< <ref-list> | < <object-list>]"),
185
NULL
186
};
187
builtin/sparse-checkout.c
+1
-1
@@ -20,7 +20,7 @@
20
static const char *empty_base = "";
21
22
static char const * const builtin_sparse_checkout_usage[] = {
23
- N_("git sparse-checkout (init | list | set | add | reapply | disable) <options>"),
23
+ N_("git sparse-checkout (init | list | set | add | reapply | disable) [<options>]"),
24
NULL
25
};
26
t/helper/test-proc-receive.c
+1
-1
@@ -6,7 +6,7 @@
6
#include "test-tool.h"
7
8
static const char *proc_receive_usage[] = {
9
- "test-tool proc-receive [<options>...]",
9
+ "test-tool proc-receive [<options>]",
10
NULL
11
};
12