]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc txt & -h consistency: use "<options>", not "<options>..."
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Thu, 13 Oct 2022 15:39:08 +0000 (17:39 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 13 Oct 2022 16:32:55 +0000 (09:32 -0700)
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>
Documentation/git-mv.txt
Documentation/git-status.txt
builtin/pack-objects.c
builtin/sparse-checkout.c
t/helper/test-proc-receive.c

index 79449bf98fe56b10f80a2d106dcfb7a3289da555..972a055fbd83d2c114aec46d3d982512b2f387a1 100644 (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
 -----------
index 54a4b29b473cc4e928b484286b01b337c9b25bdd..5e438a7fdc1ca4e8684c52c3773a6f722b26c287 100644 (file)
@@ -9,7 +9,7 @@ git-status - Show the working tree status
 SYNOPSIS
 --------
 [verse]
-'git status' [<options>...] [--] [<pathspec>...]
+'git status' [<options>] [--] [<pathspec>...]
 
 DESCRIPTION
 -----------
index 46e267749637db567eefffbfa62cc7a3bf89db33..6a8edd5711e11f333f2dd0da9eab514c76fb0201 100644 (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
 };
 
index aac0f708e426615f9067e8c00639b8b31e6314c3..58a22503f049baef60fafc363e0f5d82d1ddf368 100644 (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
 };
 
index cc08506cf0bb73b1aefda41079f60cba1edcb9c1..a4b305f4947fd21da757807a4e85c1c62987867f 100644 (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
 };