documentation: trivial style cleanups

White-spaces, missing braces, standardize --[no-]foo.

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 19d57a80f572c221c6a4d678a0673996416c5208..5bbe7b6d10de652658871048329c5dd60f1e12e0 100644 (file)
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -9,12 +9,12 @@ git-am - Apply a series of patches from a mailbox
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git am' [--signoff] [--keep] [--keep-cr | --no-keep-cr] [--utf8 | --no-utf8]
+'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8]

         [--3way] [--interactive] [--committer-date-is-author-date]
         [--ignore-date] [--ignore-space-change | --ignore-whitespace]
         [--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
         [--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
         [--3way] [--interactive] [--committer-date-is-author-date]
         [--ignore-date] [--ignore-space-change | --ignore-whitespace]
         [--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
         [--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]

-        [--scissors | --no-scissors]
+        [--[no-]scissors]

         [(<mbox> | <Maildir>)...]
 'git am' (--continue | --skip | --abort)
 
         [(<mbox> | <Maildir>)...]
 'git am' (--continue | --skip | --abort)
 


@@ -43,8 +43,7 @@ OPTIONS
 --keep-non-patch::
        Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
 
 --keep-non-patch::
        Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
 

---keep-cr::
---no-keep-cr::
+--[no-]keep-cr::

        With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
        with the same option, to prevent it from stripping CR at the end of
        lines. `am.keepcr` configuration variable can be used to specify the
        With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
        with the same option, to prevent it from stripping CR at the end of
        lines. `am.keepcr` configuration variable can be used to specify the

diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index 250e5228a35165e72f2f55fd347941c3a2a1d08c..b97aaab4edfc33f407f7d167f015b174c2ddccb5 100644 (file)
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -10,7 +10,7 @@ SYNOPSIS
 --------
 [verse]
 'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
 --------
 [verse]
 'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]

-             [-o | --output=<file>] [--worktree-attributes]
+             [-o <file> | --output=<file>] [--worktree-attributes]

              [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
              [<path>...]
 
              [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
              [<path>...]
 

diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt
index ec1739a896074c96bd94603592ca72bcee0b927f..a49be1bab49ddcdb65e4b45b578bd183a94657a5 100644 (file)
--- a/Documentation/git-check-ref-format.txt
+++ b/Documentation/git-check-ref-format.txt
@@ -83,8 +83,7 @@ typed the branch name.
 
 OPTIONS
 -------
 
 OPTIONS
 -------

---allow-onelevel::
---no-allow-onelevel::
+--[no-]allow-onelevel::

        Controls whether one-level refnames are accepted (i.e.,
        refnames that do not contain multiple `/`-separated
        components).  The default is `--no-allow-onelevel`.
        Controls whether one-level refnames are accepted (i.e.,
        refnames that do not contain multiple `/`-separated
        components).  The default is `--no-allow-onelevel`.

diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 5c16e317f66f326fac0dd0e5d70e26152aee66d3..a0727d7759aefef4dede0fb40008b7b1ee957b2d 100644 (file)
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -14,7 +14,7 @@ SYNOPSIS
          [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
          [--separate-git-dir <git dir>]
          [--depth <depth>] [--[no-]single-branch]
          [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
          [--separate-git-dir <git dir>]
          [--depth <depth>] [--[no-]single-branch]

-         [--recursive|--recurse-submodules] [--] <repository>
+         [--recursive | --recurse-submodules] [--] <repository>

          [<directory>]
 
 DESCRIPTION
          [<directory>]
 
 DESCRIPTION


@@ -188,7 +188,7 @@ objects from the source repository into a pack in the cloned repository.
        with a long history, and would want to send in fixes
        as patches.
 
        with a long history, and would want to send in fixes
        as patches.
 

---single-branch::
+--[no-]single-branch::

        Clone only the history leading to the tip of a single branch,
        either specified by the `--branch` option or the primary
        branch remote's `HEAD` points at. When creating a shallow
        Clone only the history leading to the tip of a single branch,
        either specified by the `--branch` option or the primary
        branch remote's `HEAD` points at. When creating a shallow

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 8172938653552c0b4cc3f3154195a7d83721a5a3..1a7616c73a204f69bca98d0ff7f4cdfda20ba420 100644 (file)
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -12,7 +12,7 @@ SYNOPSIS
           [--dry-run] [(-c | -C | --fixup | --squash) <commit>]
           [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
           [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
           [--dry-run] [(-c | -C | --fixup | --squash) <commit>]
           [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
           [--allow-empty-message] [--no-verify] [-e] [--author=<author>]

-          [--date=<date>] [--cleanup=<mode>] [--status | --no-status]
+          [--date=<date>] [--cleanup=<mode>] [--[no-]status]

           [-i | -o] [-S[<keyid>]] [--] [<file>...]
 
 DESCRIPTION
           [-i | -o] [-S[<keyid>]] [--] [<file>...]
 
 DESCRIPTION

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 9ae2508f3fb79b9da5fb4481a4fe2120f4a082b1..d88a6fcb29395ac200930191518fdbceca78bbd4 100644 (file)
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -186,8 +186,7 @@ See also <<FILES>>.
        Opens an editor to modify the specified config file; either
        '--system', '--global', or repository (default).
 
        Opens an editor to modify the specified config file; either
        '--system', '--global', or repository (default).
 

---includes::
---no-includes::
+--[no-]includes::

        Respect `include.*` directives in config files when looking up
        values. Defaults to on.
 
        Respect `include.*` directives in config files when looking up
        values. Defaults to on.
 

diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index bfb106cccd5880f0cd40b03059aa79a5569acb63..223f7315236be845a158f63d5909804f965837ba 100644 (file)
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -16,8 +16,10 @@ SYNOPSIS
             [--reuseaddr] [--detach] [--pid-file=<file>]
             [--enable=<service>] [--disable=<service>]
             [--allow-override=<service>] [--forbid-override=<service>]
             [--reuseaddr] [--detach] [--pid-file=<file>]
             [--enable=<service>] [--disable=<service>]
             [--allow-override=<service>] [--forbid-override=<service>]

-            [--access-hook=<path>]
-            [--inetd | [--listen=<host_or_ipaddr>] [--port=<n>] [--user=<user> [--group=<group>]]
+            [--access-hook=<path>] [--[no-]informative-errors]
+            [--inetd |
+             [--listen=<host_or_ipaddr>] [--port=<n>]
+             [--user=<user> [--group=<group>]]]

             [<directory>...]
 
 DESCRIPTION
             [<directory>...]
 
 DESCRIPTION


@@ -169,8 +171,7 @@ Git configuration files in that directory are readable by `<user>`.
        repository configuration.  By default, all the services
        are overridable.
 
        repository configuration.  By default, all the services
        are overridable.
 

---informative-errors::
---no-informative-errors::
+--[no-]informative-errors::

        When informative errors are turned on, git-daemon will report
        more verbose errors to the client, differentiating conditions
        like "no such repository" from "repository not exported". This
        When informative errors are turned on, git-daemon will report
        more verbose errors to the client, differentiating conditions
        like "no such repository" from "repository not exported". This

diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
index 8361e6e4e3d2d4829d3ce3c6f3ec4a2ac974e86e..11887e63a05904d95f7d07d51b818721b33c0b66 100644 (file)
--- a/Documentation/git-difftool.txt
+++ b/Documentation/git-difftool.txt
@@ -69,8 +69,7 @@ with custom merge tool commands and has the same value as `$MERGED`.
 --tool-help::
        Print a list of diff tools that may be used with `--tool`.
 
 --tool-help::
        Print a list of diff tools that may be used with `--tool`.
 

---symlinks::
---no-symlinks::
+--[no-]symlinks::

        'git difftool''s default behavior is create symlinks to the
        working tree when run in `--dir-diff` mode and the right-hand
        side of the comparison yields the same content as the file in
        'git difftool''s default behavior is create symlinks to the
        working tree when run in `--dir-diff` mode and the right-hand
        side of the comparison yields the same content as the file in

diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt
index 03fc8c39d8607677533b72c39b11e14151ac5b60..efb03806f507789877219f87217841d6deb5cd26 100644 (file)
--- a/Documentation/git-fast-export.txt
+++ b/Documentation/git-fast-export.txt
@@ -106,11 +106,11 @@ marks the same across runs.
        different from the commit's first parent).
 
 [<git-rev-list-args>...]::
        different from the commit's first parent).
 
 [<git-rev-list-args>...]::

-       A list of arguments, acceptable to 'git rev-parse' and
-       'git rev-list', that specifies the specific objects and references
-       to export.  For example, `master~10..master` causes the
-       current master reference to be exported along with all objects
-       added since its 10th ancestor commit.
+       A list of arguments, acceptable to 'git rev-parse' and
+       'git rev-list', that specifies the specific objects and references
+       to export.  For example, `master~10..master` causes the
+       current master reference to be exported along with all objects
+       added since its 10th ancestor commit.

 
 EXAMPLES
 --------
 
 EXAMPLES
 --------

diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt
index b81e90d8e70722e0da690ab5afa1bca4ad356b68..1e717543470c0440a72812a046bcadf0e52e4953 100644 (file)
--- a/Documentation/git-fetch-pack.txt
+++ b/Documentation/git-fetch-pack.txt
@@ -10,9 +10,9 @@ SYNOPSIS
 --------
 [verse]
 'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag]
 --------
 [verse]
 'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag]

-                               [--upload-pack=<git-upload-pack>]
-                               [--depth=<n>] [--no-progress]
-                               [-v] [<host>:]<directory> [<refs>...]
+       [--upload-pack=<git-upload-pack>]
+       [--depth=<n>] [--no-progress]
+       [-v] [<host>:]<directory> [<refs>...]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 3a0f55ec8e273545af3a92a9b886511ac79ba73c..bb1232a52c4f0e4995f1fd38737461165772c239 100644 (file)
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -35,8 +35,7 @@ OPTIONS
        Do not list one-line descriptions from the actual commits being
        merged.
 
        Do not list one-line descriptions from the actual commits being
        merged.
 

---summary::
---no-summary::
+--[no-]summary::

        Synonyms to --log and --no-log; these are deprecated and will be
        removed in the future.
 
        Synonyms to --log and --no-log; these are deprecated and will be
        removed in the future.
 

diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index e5878bd97be849046951b06235fa19bf8aef7b1c..25c431d3c552d523c79473cf10867a3cab00c259 100644 (file)
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -30,8 +30,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
        Print out objects that exist but that aren't reachable from any
        of the reference nodes.
 
        Print out objects that exist but that aren't reachable from any
        of the reference nodes.
 

---dangling::
---no-dangling::
+--[no-]dangling::

        Print objects that exist but that are never 'directly' used (default).
        `--no-dangling` can be used to omit this information from the output.
 
        Print objects that exist but that are never 'directly' used (default).
        `--no-dangling` can be used to omit this information from the output.
 


@@ -78,8 +77,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
        a blob, the contents are written into the file, rather than
        its object name.
 
        a blob, the contents are written into the file, rather than
        its object name.
 

---progress::
---no-progress::
+--[no-]progress::

        Progress status is reported on the standard error stream by
        default when it is attached to a terminal, unless
        --no-progress or --verbose is specified. --progress forces
        Progress status is reported on the standard error stream by
        default when it is attached to a terminal, unless
        --no-progress or --verbose is specified. --progress forces

diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 50d46e1a7bae054d7c1afdeb01b9174a3a9c7002..8497aa4494778134cad5ca2c2b11fb1c824e2a24 100644 (file)
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -25,7 +25,7 @@ SYNOPSIS
           [-W | --function-context]
           [-f <file>] [-e] <pattern>
           [--and|--or|--not|(|)|-e <pattern>...]
           [-W | --function-context]
           [-f <file>] [-e] <pattern>
           [--and|--or|--not|(|)|-e <pattern>...]

-          [ [--exclude-standard] [--cached | --no-index | --untracked] | <tree>...]
+          [ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | <tree>...]

           [--] [<pathspec>...]
 
 DESCRIPTION
           [--] [<pathspec>...]
 
 DESCRIPTION

diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt
index 97e7a8e9e7cc01bc350d57ca66e08f5ed96221de..164a3c6ede9be2c3a42cf0ba3612403114d4dde5 100644 (file)
--- a/Documentation/git-mailinfo.txt
+++ b/Documentation/git-mailinfo.txt
@@ -9,7 +9,7 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>
+'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--[no-]scissors] <msg> <patch>

 
 
 DESCRIPTION
 
 
 DESCRIPTION

diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 42391f2ae76aa579605470b6cad8cf4812f29aae..67ca99cd92e371ae7518d4574e2a8507d78e0823 100644 (file)
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -76,8 +76,7 @@ The 'git fmt-merge-msg' command can be
 used to give a good default for automated 'git merge'
 invocations.
 
 used to give a good default for automated 'git merge'
 invocations.
 

---rerere-autoupdate::
---no-rerere-autoupdate::
+--[no-]rerere-autoupdate::

        Allow the rerere mechanism to update the index with the
        result of auto-conflict resolution if possible.
 
        Allow the rerere mechanism to update the index with the
        result of auto-conflict resolution if possible.
 

diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
index 6b563c500f660486951cbcac62876bbda5cc3975..07137f252b0fd57a671ef69884bea893cdd7767c 100644 (file)
--- a/Documentation/git-mergetool.txt
+++ b/Documentation/git-mergetool.txt
@@ -8,7 +8,7 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git mergetool' [--tool=<tool>] [-y|--no-prompt|--prompt] [<file>...]
+'git mergetool' [--tool=<tool>] [-y | --[no-]prompt] [<file>...]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index eb2883c94cfad91efcc1f70bbdbc1609a3702d3b..d51481394c08ef6e0706bc6ff0ccd6908cddc7b8 100644 (file)
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -162,8 +162,7 @@ useful if you write an alias or script around 'git push'.
        linkgit:git-pull[1] and other commands. For more information,
        see 'branch.<name>.merge' in linkgit:git-config[1].
 
        linkgit:git-pull[1] and other commands. For more information,
        see 'branch.<name>.merge' in linkgit:git-config[1].
 

---thin::
---no-thin::
+--[no-]thin::

        These options are passed to linkgit:git-send-pack[1]. A thin transfer
        significantly reduces the amount of sent data when the sender and
        receiver share many of the same objects in common. The default is
        These options are passed to linkgit:git-send-pack[1]. A thin transfer
        significantly reduces the amount of sent data when the sender and
        receiver share many of the same objects in common. The default is

diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 7a6f3546803b8a6d71e44f5123a43397ace1f543..581bb4c413fb70956430bb7359bbee3bbc1a24e6 100644 (file)
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -10,7 +10,7 @@ SYNOPSIS
 --------
 [verse]
 'git remote' [-v | --verbose]
 --------
 [verse]
 'git remote' [-v | --verbose]

-'git remote add' [-t <branch>] [-m <master>] [-f] [--tags|--no-tags] [--mirror=<fetch|push>] <name> <url>
+'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <name> <url>

 'git remote rename' <old> <new>
 'git remote remove' <name>
 'git remote set-head' <name> (-a | -d | <branch>)
 'git remote rename' <old> <new>
 'git remote remove' <name>
 'git remote set-head' <name> (-a | -d | <branch>)

diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 70152e8b1eb31e5ed6e7da889a424bc65c1f16c2..f79c9d858301353043fe0878bee268d8eacde189 100644 (file)
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -8,7 +8,7 @@ git-revert - Revert some existing commits
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>...
+'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] <commit>...

 'git revert' --continue
 'git revert' --quit
 'git revert' --abort
 'git revert' --continue
 'git revert' --quit
 'git revert' --abort

diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 670e9fb2c2baa1ce40415d273c08d5b137868432..e0a87029cdfe9fadd9edd4cc493bedd6b5044ac3 100644 (file)
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -14,8 +14,8 @@ SYNOPSIS
             [--refresh] [-q] [--unmerged] [--ignore-missing]
             [(--cacheinfo <mode> <object> <file>)...]
             [--chmod=(+|-)x]
             [--refresh] [-q] [--unmerged] [--ignore-missing]
             [(--cacheinfo <mode> <object> <file>)...]
             [--chmod=(+|-)x]

-            [--assume-unchanged | --no-assume-unchanged]
-            [--skip-worktree | --no-skip-worktree]
+            [--[no-]assume-unchanged]
+            [--[no-]skip-worktree]

             [--ignore-submodules]
             [--really-refresh] [--unresolve] [--again | -g]
             [--info-only] [--index-info]
             [--ignore-submodules]
             [--really-refresh] [--unresolve] [--again | -g]
             [--info-only] [--index-info]


@@ -77,8 +77,7 @@ OPTIONS
 --chmod=(+|-)x::
         Set the execute permissions on the updated files.
 
 --chmod=(+|-)x::
         Set the execute permissions on the updated files.
 

---assume-unchanged::
---no-assume-unchanged::
+--[no-]assume-unchanged::

        When these flags are specified, the object names recorded
        for the paths are not updated.  Instead, these options
        set and unset the "assume unchanged" bit for the
        When these flags are specified, the object names recorded
        for the paths are not updated.  Instead, these options
        set and unset the "assume unchanged" bit for the


@@ -102,8 +101,7 @@ you will need to handle the situation manually.
        Like '--refresh', but checks stat information unconditionally,
        without regard to the "assume unchanged" setting.
 
        Like '--refresh', but checks stat information unconditionally,
        without regard to the "assume unchanged" setting.
 

---skip-worktree::
---no-skip-worktree::
+--[no-]skip-worktree::

        When one of these flags is specified, the object name recorded
        for the paths are not updated. Instead, these options
        set and unset the "skip-worktree" bit for the paths. See
        When one of these flags is specified, the object name recorded
        for the paths are not updated. Instead, these options
        set and unset the "skip-worktree" bit for the paths. See