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>

diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt
index bf1febb9ae72e72230c92d67ae719e7cf19039e3..591e3801b7b164cfdf412864cee46a7612b21fd2 100644 (file)
--- 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] [<common-diff-options>] [<path>...]
+'git diff-files' [-q] [-0 | -1 | -2 | -3 | -c | --cc] [<common-diff-options>] [<path>...]
 
 DESCRIPTION
 -----------

diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt
index 58670ef12f72f9cfbf0aa2a6774d03382f57590e..472b5bb995be278415daede21a5489ed2d4c01da 100644 (file)
--- 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 <type>] [-w] [--path=<file>|--no-filters]
+'git hash-object' [-t <type>] [-w] [--path=<file> | --no-filters]
                [--stdin [--literally]] [--] <file>...
 'git hash-object' [-t <type>] [-w] --stdin-paths [--no-filters]
 

diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt
index 2d944e0851f6a8e295bf8d8e0aac14725e1b4326..b01ba3d35650969ff446627e4f2f403eb84c7c0e 100644 (file)
--- 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] <commit> <commit>...
-'git merge-base' [-a|--all] --octopus <commit>...
+'git merge-base' [-a | --all] <commit> <commit>...
+'git merge-base' [-a | --all] --octopus <commit>...
 'git merge-base' --is-ancestor <commit> <commit>
 'git merge-base' --independent <commit>...
 'git merge-base' --fork-point <ref> [<commit>]

diff --git a/Documentation/git-pack-redundant.txt b/Documentation/git-pack-redundant.txt
index ee7034b5e52d2e9711196f4197ac3520cfdad0e0..dda80a740c879d1a1300caad3478a56ce62cad2a 100644 (file)
--- 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 | <pack-filename>... )
+'git pack-redundant' [--verbose] [--alt-odb] (--all | <pack-filename>...)
 
 DESCRIPTION
 -----------

diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt
index 9fed59a31724c4dccd7364c03c32c72d9c8d4664..844d6f808a0c2f740d62ac7dbe5ed0c328546262 100644 (file)
--- 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 4b613d4140c1cd1d0af616b15f2fb21758853fe8..9d0e6f53e7e009cf4fa693f4dc82078fff6e0a76 100644 (file)
--- 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 <pathspec>|diff|remaining|status|gc]
+'git rerere' [clear | forget <pathspec> | diff | remaining | status | gc]
 
 DESCRIPTION
 -----------

diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt
index be41f119740ea7f5e2f53d3211e608bf4255544f..e0c71623432bc2ccb0ce7ae8ec05ae25196526cd 100644 (file)
--- 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=<git-receive-pack>]
                [--verbose] [--thin] [--atomic]
-               [--[no-]signed|--signed=(true|false|if-asked)]
+               [--[no-]signed | --signed=(true|false|if-asked)]
                [<host>:]<directory> (--all | <ref>...)
 
 DESCRIPTION

diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 5cc2fcefbab1bcc80b33192e7ac06a3a5a92efd2..e0d71a208c4c8a2aa1c7fcd53896fddc0f0d28e9 100644 (file)
--- 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[=<when>] | --no-color] [--sparse]
                [--more=<n> | --list | --independent | --merge-base]
                [--no-name | --sha1-name] [--topics]
                [(<rev> | <glob>)...]
-'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]
+'git show-branch' (-g | --reflog)[=<n>[,<base>]] [--list] [<ref>]
 
 DESCRIPTION
 -----------

diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index ab4d271925da7983b16867d89e898bbed17ae469..d1d56f68b4376279534d61ec44db10e9e6efd297 100644 (file)
--- 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[=<n>]] [--abbrev[=<n>]] [--tags]
+'git show-ref' [-q | --quiet] [--verify] [--head] [-d | --dereference]
+            [-s | --hash[=<n>]] [--abbrev[=<n>]] [--tags]
             [--heads] [--] [<pattern>...]
 'git show-ref' --exclude-existing[=<pattern>]
 

diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
index 387cc1b91420f78da6d16016af8cdc757db6dd44..6aa521fab2383e5e0d4aaf39d03f695ea53940d3 100644 (file)
--- 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 | <variable> )
+'git var' (-l | <variable>)
 
 DESCRIPTION
 -----------

diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt
index 61ca6d04c206dc5667ffe83b8dd3c9cc4d1ab31c..b8720dce8abc34fffee6fa1235c48976ad44f1fb 100644 (file)
--- 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] [--] <pack>.idx ...
+'git verify-pack' [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...
 
 
 DESCRIPTION

diff --git a/builtin/bugreport.c b/builtin/bugreport.c
index bb138161943ba2d8bd23dbe868e9d4c78777b463..61d93383f515d4a3722a9a0fa5752d161816e763 100644 (file)
--- 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) <file>] [(-s|--suffix) <format>]\n"
+       N_("git bugreport [(-o | --output-directory) <file>] [(-s | --suffix) <format>]\n"
           "              [--diagnose[=<mode>]]"),
        NULL
 };

diff --git a/builtin/commit-graph.c b/builtin/commit-graph.c
index 50b1a171566fed6f026c202cbe08dd547f82f09f..c21cfd56696f43fab9750679cc46d439d5fdf110 100644 (file)
--- 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 <objdir>] [--append]\n" \
-          "                       [--split[=<strategy>]] [--reachable|--stdin-packs|--stdin-commits]\n" \
+          "                       [--split[=<strategy>]] [--reachable | --stdin-packs | --stdin-commits]\n" \
           "                       [--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]\n" \
           "                       <split options>")
 

diff --git a/builtin/diagnose.c b/builtin/diagnose.c
index 54491f2c51c25fbe354f25dc14b4aa0f649bedd1..64a65e2842b1b92f05460e12cfb7b6c6671e4ed0 100644 (file)
--- 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) <path>] [(-s|--suffix) <format>]\n"
+       N_("git diagnose [(-o | --output-directory) <path>] [(-s | --suffix) <format>]\n"
           "             [--mode=<mode>]"),
        NULL
 };

diff --git a/builtin/sparse-checkout.c b/builtin/sparse-checkout.c
index 287716db68e4198bdec97517ff2cd9c053c9f0b8..aac0f708e426615f9067e8c00639b8b31e6314c3 100644 (file)
--- 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) <options>"),
+       N_("git sparse-checkout (init | list | set | add | reapply | disable) <options>"),
        NULL
 };