doc txt & -h consistency: correct padding around "[]()"
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 | <pack-filename>...)" is correct, not "( --all | <pack-filename>... )". 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
e2f4e7e8c0f77e45c51ac937fb870351517437c8
15 files changed
+18
-18
Documentation/git-diff-files.txt
+1
-1
@@ -9,7 +9,7 @@ git-diff-files - Compares files in the working tree and the index
9
SYNOPSIS
10
--------
11
[verse]
12
-'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common-diff-options>] [<path>...]
12
+'git diff-files' [-q] [-0 | -1 | -2 | -3 | -c | --cc] [<common-diff-options>] [<path>...]
13
14
DESCRIPTION
15
-----------
Documentation/git-hash-object.txt
+1
-1
@@ -9,7 +9,7 @@ git-hash-object - Compute object ID and optionally creates a blob from a file
9
SYNOPSIS
10
--------
11
[verse]
12
-'git hash-object' [-t <type>] [-w] [--path=<file>|--no-filters]
12
+'git hash-object' [-t <type>] [-w] [--path=<file> | --no-filters]
13
[--stdin [--literally]] [--] <file>...
14
'git hash-object' [-t <type>] [-w] --stdin-paths [--no-filters]
15
Documentation/git-merge-base.txt
+2
-2
@@ -9,8 +9,8 @@ git-merge-base - Find as good common ancestors as possible for a merge
9
SYNOPSIS
10
--------
11
[verse]
12
-'git merge-base' [-a|--all] <commit> <commit>...
13
-'git merge-base' [-a|--all] --octopus <commit>...
12
+'git merge-base' [-a | --all] <commit> <commit>...
13
+'git merge-base' [-a | --all] --octopus <commit>...
14
'git merge-base' --is-ancestor <commit> <commit>
15
'git merge-base' --independent <commit>...
16
'git merge-base' --fork-point <ref> [<commit>]
Documentation/git-pack-redundant.txt
+1
-1
@@ -9,7 +9,7 @@ git-pack-redundant - Find redundant pack files
9
SYNOPSIS
10
--------
11
[verse]
12
-'git pack-redundant' [ --verbose ] [ --alt-odb ] ( --all | <pack-filename>... )
12
+'git pack-redundant' [--verbose] [--alt-odb] (--all | <pack-filename>...)
13
14
DESCRIPTION
15
-----------
Documentation/git-prune-packed.txt
+1
-1
@@ -9,7 +9,7 @@ git-prune-packed - Remove extra objects that are already in pack files
9
SYNOPSIS
10
--------
11
[verse]
12
-'git prune-packed' [-n|--dry-run] [-q|--quiet]
12
+'git prune-packed' [-n | --dry-run] [-q | --quiet]
13
14
15
DESCRIPTION
Documentation/git-rerere.txt
+1
-1
@@ -8,7 +8,7 @@ git-rerere - Reuse recorded resolution of conflicted merges
8
SYNOPSIS
9
--------
10
[verse]
11
-'git rerere' [clear|forget <pathspec>|diff|remaining|status|gc]
11
+'git rerere' [clear | forget <pathspec> | diff | remaining | status | gc]
12
13
DESCRIPTION
14
-----------
Documentation/git-send-pack.txt
+1
-1
@@ -11,7 +11,7 @@ SYNOPSIS
11
[verse]
12
'git send-pack' [--dry-run] [--force] [--receive-pack=<git-receive-pack>]
13
[--verbose] [--thin] [--atomic]
14
- [--[no-]signed|--signed=(true|false|if-asked)]
14
+ [--[no-]signed | --signed=(true|false|if-asked)]
15
[<host>:]<directory> (--all | <ref>...)
16
17
DESCRIPTION
Documentation/git-show-branch.txt
+2
-2
@@ -8,12 +8,12 @@ git-show-branch - Show branches and their commits
8
SYNOPSIS
9
--------
10
[verse]
11
-'git show-branch' [-a|--all] [-r|--remotes] [--topo-order | --date-order]
11
+'git show-branch' [-a | --all] [-r | --remotes] [--topo-order | --date-order]
12
[--current] [--color[=<when>] | --no-color] [--sparse]
13
[--more=<n> | --list | --independent | --merge-base]
14
[--no-name | --sha1-name] [--topics]
15
[(<rev> | <glob>)...]
16
-'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]
16
+'git show-branch' (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]
17
18
DESCRIPTION
19
-----------
Documentation/git-show-ref.txt
+2
-2
@@ -8,8 +8,8 @@ git-show-ref - List references in a local repository
8
SYNOPSIS
9
--------
10
[verse]
11
-'git show-ref' [-q|--quiet] [--verify] [--head] [-d|--dereference]
12
- [-s|--hash[=<n>]] [--abbrev[=<n>]] [--tags]
11
+'git show-ref' [-q | --quiet] [--verify] [--head] [-d | --dereference]
12
+ [-s | --hash[=<n>]] [--abbrev[=<n>]] [--tags]
13
[--heads] [--] [<pattern>...]
14
'git show-ref' --exclude-existing[=<pattern>]
15
Documentation/git-var.txt
+1
-1
@@ -9,7 +9,7 @@ git-var - Show a Git logical variable
9
SYNOPSIS
10
--------
11
[verse]
12
-'git var' ( -l | <variable> )
12
+'git var' (-l | <variable>)
13
14
DESCRIPTION
15
-----------
Documentation/git-verify-pack.txt
+1
-1
@@ -9,7 +9,7 @@ git-verify-pack - Validate packed Git archive files
9
SYNOPSIS
10
--------
11
[verse]
12
-'git verify-pack' [-v|--verbose] [-s|--stat-only] [--] <pack>.idx ...
12
+'git verify-pack' [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...
13
14
15
DESCRIPTION
builtin/bugreport.c
+1
-1
@@ -60,7 +60,7 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)
60
}
61
62
static const char * const bugreport_usage[] = {
63
- N_("git bugreport [(-o|--output-directory) <file>] [(-s|--suffix) <format>]\n"
63
+ N_("git bugreport [(-o | --output-directory) <file>] [(-s | --suffix) <format>]\n"
64
" [--diagnose[=<mode>]]"),
65
NULL
66
};
builtin/commit-graph.c
+1
-1
@@ -14,7 +14,7 @@
14
15
#define BUILTIN_COMMIT_GRAPH_WRITE_USAGE \
16
N_("git commit-graph write [--object-dir <objdir>] [--append]\n" \
17
- " [--split[=<strategy>]] [--reachable|--stdin-packs|--stdin-commits]\n" \
17
+ " [--split[=<strategy>]] [--reachable | --stdin-packs | --stdin-commits]\n" \
18
" [--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]\n" \
19
" <split options>")
20
builtin/diagnose.c
+1
-1
@@ -3,7 +3,7 @@
3
#include "diagnose.h"
4
5
static const char * const diagnose_usage[] = {
6
- N_("git diagnose [(-o|--output-directory) <path>] [(-s|--suffix) <format>]\n"
6
+ N_("git diagnose [(-o | --output-directory) <path>] [(-s | --suffix) <format>]\n"
7
" [--mode=<mode>]"),
8
NULL
9
};
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