From e2f4e7e8c0f77e45c51ac937fb870351517437c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= Date: Thu, 13 Oct 2022 17:39:06 +0200 Subject: [PATCH] doc txt & -h consistency: correct padding around "[]()" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The whitespace padding of alternatives should be of the form "[-f | --force]" not "[-f|--force]". Likewise we should not have padding before the first option, so "(--all | ...)" is correct, not "( --all | ... )". Signed-off-by: Ævar Arnfjörð Bjarmason Signed-off-by: Junio C Hamano --- Documentation/git-diff-files.txt | 2 +- Documentation/git-hash-object.txt | 2 +- Documentation/git-merge-base.txt | 4 ++-- Documentation/git-pack-redundant.txt | 2 +- Documentation/git-prune-packed.txt | 2 +- Documentation/git-rerere.txt | 2 +- Documentation/git-send-pack.txt | 2 +- Documentation/git-show-branch.txt | 4 ++-- Documentation/git-show-ref.txt | 4 ++-- Documentation/git-var.txt | 2 +- Documentation/git-verify-pack.txt | 2 +- builtin/bugreport.c | 2 +- builtin/commit-graph.c | 2 +- builtin/diagnose.c | 2 +- builtin/sparse-checkout.c | 2 +- 15 files changed, 18 insertions(+), 18 deletions(-) diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt index bf1febb9ae..591e3801b7 100644 --- a/Documentation/git-diff-files.txt +++ b/Documentation/git-diff-files.txt @@ -9,7 +9,7 @@ git-diff-files - Compares files in the working tree and the index SYNOPSIS -------- [verse] -'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [] [...] +'git diff-files' [-q] [-0 | -1 | -2 | -3 | -c | --cc] [] [...] DESCRIPTION ----------- diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt index 58670ef12f..472b5bb995 100644 --- a/Documentation/git-hash-object.txt +++ b/Documentation/git-hash-object.txt @@ -9,7 +9,7 @@ git-hash-object - Compute object ID and optionally creates a blob from a file SYNOPSIS -------- [verse] -'git hash-object' [-t ] [-w] [--path=|--no-filters] +'git hash-object' [-t ] [-w] [--path= | --no-filters] [--stdin [--literally]] [--] ... 'git hash-object' [-t ] [-w] --stdin-paths [--no-filters] diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index 2d944e0851..b01ba3d356 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -9,8 +9,8 @@ git-merge-base - Find as good common ancestors as possible for a merge SYNOPSIS -------- [verse] -'git merge-base' [-a|--all] ... -'git merge-base' [-a|--all] --octopus ... +'git merge-base' [-a | --all] ... +'git merge-base' [-a | --all] --octopus ... 'git merge-base' --is-ancestor 'git merge-base' --independent ... 'git merge-base' --fork-point [] diff --git a/Documentation/git-pack-redundant.txt b/Documentation/git-pack-redundant.txt index ee7034b5e5..dda80a740c 100644 --- a/Documentation/git-pack-redundant.txt +++ b/Documentation/git-pack-redundant.txt @@ -9,7 +9,7 @@ git-pack-redundant - Find redundant pack files SYNOPSIS -------- [verse] -'git pack-redundant' [ --verbose ] [ --alt-odb ] ( --all | ... ) +'git pack-redundant' [--verbose] [--alt-odb] (--all | ...) DESCRIPTION ----------- diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt index 9fed59a317..844d6f808a 100644 --- a/Documentation/git-prune-packed.txt +++ b/Documentation/git-prune-packed.txt @@ -9,7 +9,7 @@ git-prune-packed - Remove extra objects that are already in pack files SYNOPSIS -------- [verse] -'git prune-packed' [-n|--dry-run] [-q|--quiet] +'git prune-packed' [-n | --dry-run] [-q | --quiet] DESCRIPTION diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 4b613d4140..9d0e6f53e7 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -8,7 +8,7 @@ git-rerere - Reuse recorded resolution of conflicted merges SYNOPSIS -------- [verse] -'git rerere' [clear|forget |diff|remaining|status|gc] +'git rerere' [clear | forget | diff | remaining | status | gc] DESCRIPTION ----------- diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index be41f11974..e0c7162343 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] 'git send-pack' [--dry-run] [--force] [--receive-pack=] [--verbose] [--thin] [--atomic] - [--[no-]signed|--signed=(true|false|if-asked)] + [--[no-]signed | --signed=(true|false|if-asked)] [:] (--all | ...) DESCRIPTION diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 5cc2fcefba..e0d71a208c 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -8,12 +8,12 @@ git-show-branch - Show branches and their commits SYNOPSIS -------- [verse] -'git show-branch' [-a|--all] [-r|--remotes] [--topo-order | --date-order] +'git show-branch' [-a | --all] [-r | --remotes] [--topo-order | --date-order] [--current] [--color[=] | --no-color] [--sparse] [--more= | --list | --independent | --merge-base] [--no-name | --sha1-name] [--topics] [( | )...] -'git show-branch' (-g|--reflog)[=[,]] [--list] [] +'git show-branch' (-g | --reflog)[=[,]] [--list] [] DESCRIPTION ----------- diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index ab4d271925..d1d56f68b4 100644 --- a/Documentation/git-show-ref.txt +++ b/Documentation/git-show-ref.txt @@ -8,8 +8,8 @@ git-show-ref - List references in a local repository SYNOPSIS -------- [verse] -'git show-ref' [-q|--quiet] [--verify] [--head] [-d|--dereference] - [-s|--hash[=]] [--abbrev[=]] [--tags] +'git show-ref' [-q | --quiet] [--verify] [--head] [-d | --dereference] + [-s | --hash[=]] [--abbrev[=]] [--tags] [--heads] [--] [...] 'git show-ref' --exclude-existing[=] diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt index 387cc1b914..6aa521fab2 100644 --- a/Documentation/git-var.txt +++ b/Documentation/git-var.txt @@ -9,7 +9,7 @@ git-var - Show a Git logical variable SYNOPSIS -------- [verse] -'git var' ( -l | ) +'git var' (-l | ) DESCRIPTION ----------- diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt index 61ca6d04c2..b8720dce8a 100644 --- a/Documentation/git-verify-pack.txt +++ b/Documentation/git-verify-pack.txt @@ -9,7 +9,7 @@ git-verify-pack - Validate packed Git archive files SYNOPSIS -------- [verse] -'git verify-pack' [-v|--verbose] [-s|--stat-only] [--] .idx ... +'git verify-pack' [-v | --verbose] [-s | --stat-only] [--] .idx... DESCRIPTION diff --git a/builtin/bugreport.c b/builtin/bugreport.c index bb13816194..61d93383f5 100644 --- a/builtin/bugreport.c +++ b/builtin/bugreport.c @@ -60,7 +60,7 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit) } static const char * const bugreport_usage[] = { - N_("git bugreport [(-o|--output-directory) ] [(-s|--suffix) ]\n" + N_("git bugreport [(-o | --output-directory) ] [(-s | --suffix) ]\n" " [--diagnose[=]]"), NULL }; diff --git a/builtin/commit-graph.c b/builtin/commit-graph.c index 50b1a17156..c21cfd5669 100644 --- a/builtin/commit-graph.c +++ b/builtin/commit-graph.c @@ -14,7 +14,7 @@ #define BUILTIN_COMMIT_GRAPH_WRITE_USAGE \ N_("git commit-graph write [--object-dir ] [--append]\n" \ - " [--split[=]] [--reachable|--stdin-packs|--stdin-commits]\n" \ + " [--split[=]] [--reachable | --stdin-packs | --stdin-commits]\n" \ " [--changed-paths] [--[no-]max-new-filters ] [--[no-]progress]\n" \ " ") diff --git a/builtin/diagnose.c b/builtin/diagnose.c index 54491f2c51..64a65e2842 100644 --- a/builtin/diagnose.c +++ b/builtin/diagnose.c @@ -3,7 +3,7 @@ #include "diagnose.h" static const char * const diagnose_usage[] = { - N_("git diagnose [(-o|--output-directory) ] [(-s|--suffix) ]\n" + N_("git diagnose [(-o | --output-directory) ] [(-s | --suffix) ]\n" " [--mode=]"), NULL }; diff --git a/builtin/sparse-checkout.c b/builtin/sparse-checkout.c index 287716db68..aac0f708e4 100644 --- a/builtin/sparse-checkout.c +++ b/builtin/sparse-checkout.c @@ -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) "), + N_("git sparse-checkout (init | list | set | add | reapply | disable) "), NULL };