Skip to content

Commit 23a9235

Browse files
avargitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 0075121 commit 23a9235

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

Documentation/git-mv.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-mv - Move or rename a file, a directory, or a symlink
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git mv' <options>... <args>...
12+
'git mv' [<options>] <args>...
1313

1414
DESCRIPTION
1515
-----------

Documentation/git-status.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-status - Show the working tree status
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git status' [<options>...] [--] [<pathspec>...]
12+
'git status' [<options>] [--] [<pathspec>...]
1313

1414
DESCRIPTION
1515
-----------

builtin/pack-objects.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@ static inline void oe_set_delta_size(struct packing_data *pack,
180180
#define SET_DELTA_SIBLING(obj, val) oe_set_delta_sibling(&to_pack, obj, val)
181181

182182
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>]"),
185185
NULL
186186
};
187187

builtin/sparse-checkout.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
static const char *empty_base = "";
2121

2222
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>]"),
2424
NULL
2525
};
2626

t/helper/test-proc-receive.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#include "test-tool.h"
77

88
static const char *proc_receive_usage[] = {
9-
"test-tool proc-receive [<options>...]",
9+
"test-tool proc-receive [<options>]",
1010
NULL
1111
};
1212

0 commit comments

Comments
 (0)