Use proper syntax for replaceables in command docs

The standard for command documentation synopses appears to be:

[...] means optional
<...> means replaceable
[<...>] means both optional and replaceable

So fix a number of doc pages that use incorrect variations of the
above.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt
index 05fd482b74ed00445613c7cc9b8a0b019ae31550..e44a831339d4a6d7f9ca3d9879dbb5a9b4ffac0a 100644 (file)
--- a/Documentation/git-annotate.txt
+++ b/Documentation/git-annotate.txt
@@ -8,7 +8,7 @@ git-annotate - Annotate file lines with commit information
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git annotate' [options] file [revision]
+'git annotate' [<options>] <file> [<revision>]

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

diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt
index aa3b2bf2fcf764ca22f44bcfc081afd4e09328bb..3c0578217ba7f92f823e545021c5c06c31566f0d 100644 (file)
--- a/Documentation/git-check-attr.txt
+++ b/Documentation/git-check-attr.txt
@@ -9,8 +9,8 @@ git-check-attr - Display gitattributes information
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git check-attr' [-a | --all | attr...] [--] pathname...
-'git check-attr' --stdin [-z] [-a | --all | attr...]
+'git check-attr' [-a | --all | <attr>...] [--] <pathname>...
+'git check-attr' --stdin [-z] [-a | --all | <attr>...]

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

diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt
index 611754f10bb86d62edcb3265cc29ccdc97c259ae..8b42cb3fb20a78cde2eb4c6a7546a334cc71ec4b 100644 (file)
--- a/Documentation/git-check-ignore.txt
+++ b/Documentation/git-check-ignore.txt
@@ -9,8 +9,8 @@ git-check-ignore - Debug gitignore / exclude files
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git check-ignore' [options] pathname...
-'git check-ignore' [options] --stdin
+'git check-ignore' [<options>] <pathname>...
+'git check-ignore' [<options>] --stdin

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

diff --git a/Documentation/git-check-mailmap.txt b/Documentation/git-check-mailmap.txt
index 39028ee1a34e63325d68bb900854b4fe8aa66457..aa2055dbebcd4237e7557db7926700c933f8ac94 100644 (file)
--- a/Documentation/git-check-mailmap.txt
+++ b/Documentation/git-check-mailmap.txt
@@ -9,7 +9,7 @@ git-check-mailmap - Show canonical names and email addresses of contacts
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git check-mailmap' [options] <contact>...
+'git check-mailmap' [<options>] <contact>...

 
 
 DESCRIPTION
 
 
 DESCRIPTION

diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt
index 2b8582639332acb4d3e81273c6a90163a3a8b378..0216c18ef80c9a9d32095ec3969091aff1c20344 100644 (file)
--- a/Documentation/git-credential-cache.txt
+++ b/Documentation/git-credential-cache.txt
@@ -8,7 +8,7 @@ git-credential-cache - Helper to temporarily store passwords in memory
 SYNOPSIS
 --------
 -----------------------------
 SYNOPSIS
 --------
 -----------------------------

-git config credential.helper 'cache [options]'
+git config credential.helper 'cache [<options>]'

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

diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt
index 25fb963f4b06695bb0c5fcf9a1feed97dfc549ed..693dd9d9d760fe2a113d4e15ab7816f34b2cd47d 100644 (file)
--- a/Documentation/git-credential-store.txt
+++ b/Documentation/git-credential-store.txt
@@ -8,7 +8,7 @@ git-credential-store - Helper to store credentials on disk
 SYNOPSIS
 --------
 -------------------
 SYNOPSIS
 --------
 -------------------

-git config credential.helper 'store [options]'
+git config credential.helper 'store [<options>]'

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

diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index 37b96c5453457dc2ab4750c3ef4490f8d55438d9..f98b7c6ed7c0fe4df8a0e3211eaa53ea7c95d5d9 100644 (file)
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -22,7 +22,7 @@ cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
 Usage:
 
 [verse]
 Usage:
 
 [verse]

-'git-cvsserver' [options] [pserver|server] [<directory> ...]
+'git-cvsserver' [<options>] [pserver|server] [<directory> ...]

 
 OPTIONS
 -------
 
 OPTIONS
 -------

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 7c2c4427001f851339e48284e811a438417a02e8..b180f1fa5bf5599efd8c8fefe29e3249cd387715 100644 (file)
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -9,11 +9,11 @@ git-diff - Show changes between commits, commit and working tree, etc
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git diff' [options] [<commit>] [--] [<path>...]
-'git diff' [options] --cached [<commit>] [--] [<path>...]
-'git diff' [options] <commit> <commit> [--] [<path>...]
-'git diff' [options] <blob> <blob>
-'git diff' [options] --no-index [--] <path> <path>
+'git diff' [<options>] [<commit>] [--] [<path>...]
+'git diff' [<options>] --cached [<commit>] [--] [<path>...]
+'git diff' [<options>] <commit> <commit> [--] [<path>...]
+'git diff' [<options>] <blob> <blob>
+'git diff' [<options>] --no-index [--] <path> <path>

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


@@ -21,7 +21,7 @@ Show changes between the working tree and the index or a tree, changes
 between the index and a tree, changes between two trees, changes between
 two blob objects, or changes between two files on disk.
 
 between the index and a tree, changes between two trees, changes between
 two blob objects, or changes between two files on disk.
 

-'git diff' [options] [--] [<path>...]::
+'git diff' [<options>] [--] [<path>...]::

 
        This form is to view the changes you made relative to
        the index (staging area for the next commit).  In other
 
        This form is to view the changes you made relative to
        the index (staging area for the next commit).  In other


@@ -29,7 +29,7 @@ two blob objects, or changes between two files on disk.
        further add to the index but you still haven't.  You can
        stage these changes by using linkgit:git-add[1].
 
        further add to the index but you still haven't.  You can
        stage these changes by using linkgit:git-add[1].
 

-'git diff' [options] --no-index [--] <path> <path>::
+'git diff' [<options>] --no-index [--] <path> <path>::

 
        This form is to compare the given two paths on the
        filesystem.  You can omit the `--no-index` option when
 
        This form is to compare the given two paths on the
        filesystem.  You can omit the `--no-index` option when


@@ -38,7 +38,7 @@ two blob objects, or changes between two files on disk.
        or when running the command outside a working tree
        controlled by Git.
 
        or when running the command outside a working tree
        controlled by Git.
 

-'git diff' [options] --cached [<commit>] [--] [<path>...]::
+'git diff' [<options>] --cached [<commit>] [--] [<path>...]::

 
        This form is to view the changes you staged for the next
        commit relative to the named <commit>.  Typically you
 
        This form is to view the changes you staged for the next
        commit relative to the named <commit>.  Typically you


@@ -48,7 +48,7 @@ two blob objects, or changes between two files on disk.
        <commit> is not given, it shows all staged changes.
        --staged is a synonym of --cached.
 
        <commit> is not given, it shows all staged changes.
        --staged is a synonym of --cached.
 

-'git diff' [options] <commit> [--] [<path>...]::
+'git diff' [<options>] <commit> [--] [<path>...]::

 
        This form is to view the changes you have in your
        working tree relative to the named <commit>.  You can
 
        This form is to view the changes you have in your
        working tree relative to the named <commit>.  You can


@@ -56,18 +56,18 @@ two blob objects, or changes between two files on disk.
        branch name to compare with the tip of a different
        branch.
 
        branch name to compare with the tip of a different
        branch.
 

-'git diff' [options] <commit> <commit> [--] [<path>...]::
+'git diff' [<options>] <commit> <commit> [--] [<path>...]::

 
        This is to view the changes between two arbitrary
        <commit>.
 
 
        This is to view the changes between two arbitrary
        <commit>.
 

-'git diff' [options] <commit>..<commit> [--] [<path>...]::
+'git diff' [<options>] <commit>..<commit> [--] [<path>...]::

 
        This is synonymous to the previous form.  If <commit> on
        one side is omitted, it will have the same effect as
        using HEAD instead.
 
 
        This is synonymous to the previous form.  If <commit> on
        one side is omitted, it will have the same effect as
        using HEAD instead.
 

-'git diff' [options] <commit>\...<commit> [--] [<path>...]::
+'git diff' [<options>] <commit>\...<commit> [--] [<path>...]::

 
        This form is to view the changes on the branch containing
        and up to the second <commit>, starting at a common ancestor
 
        This form is to view the changes on the branch containing
        and up to the second <commit>, starting at a common ancestor


@@ -87,7 +87,7 @@ and the range notations ("<commit>..<commit>" and
 "<commit>\...<commit>") do not mean a range as defined in the
 "SPECIFYING RANGES" section in linkgit:gitrevisions[7].
 
 "<commit>\...<commit>") do not mean a range as defined in the
 "SPECIFYING RANGES" section in linkgit:gitrevisions[7].
 

-'git diff' [options] <blob> <blob>::
+'git diff' [<options>] <blob> <blob>::

 
        This form is to view the differences between the raw
        contents of two blob objects.
 
        This form is to view the differences between the raw
        contents of two blob objects.

diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt
index 44098595dd6a2e7d303a2ee78f348207813186b8..ce954be5321384b55687791acb32562850a5a6fa 100644 (file)
--- a/Documentation/git-fast-export.txt
+++ b/Documentation/git-fast-export.txt
@@ -9,7 +9,7 @@ git-fast-export - Git data exporter
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git fast-export [options]' | 'git fast-import'
+'git fast-export [<options>]' | 'git fast-import'

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

diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index cdf696ff7f6d9873d4d5c069022eae547911ede8..e81117d27f477591b92480352731fb0c4faf3410 100644 (file)
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -9,7 +9,7 @@ git-fast-import - Backend for fast Git data importers
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-frontend | 'git fast-import' [options]
+frontend | 'git fast-import' [<options>]

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

diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index ff446f15f79f270a8979d1a398450a50ba4a4e95..9111c47a1bf2c22466bb74d3b3bca540c4fb0eb2 100644 (file)
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -8,8 +8,8 @@ git-interpret-trailers - add or parse structured information in commit messages
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git interpret-trailers' [options] [(--trailer <token>[(=|:)<value>])...] [<file>...]
-'git interpret-trailers' [options] [--parse] [<file>...]
+'git interpret-trailers' [<options>] [(--trailer <token>[(=|:)<value>])...] [<file>...]
+'git interpret-trailers' [<options>] [--parse] [<file>...]

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

diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 4e0ad6fd8e0b91d9d82ef66f8e3a10a3882589e8..118d9d86f79427373eb92753abf7e134ed925fe8 100644 (file)
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -9,7 +9,7 @@ git-pull - Fetch from and integrate with another repository or a local branch
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git pull' [options] [<repository> [<refspec>...]]
+'git pull' [<options>] [<repository> [<refspec>...]]

 
 
 DESCRIPTION
 
 
 DESCRIPTION

diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index bd5ecff980ef297df18d96453f91b30e9a34c031..0e20a66e73cf420c83b156d1a0aaa8f60cd4702f 100644 (file)
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -8,9 +8,9 @@ git-rebase - Reapply commits on top of another base tip
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git rebase' [-i | --interactive] [options] [--exec <cmd>] [--onto <newbase>]
+'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]

        [<upstream> [<branch>]]
        [<upstream> [<branch>]]

-'git rebase' [-i | --interactive] [options] [--exec <cmd>] [--onto <newbase>]
+'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]

        --root [<branch>]
 'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch
 
        --root [<branch>]
 'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch
 

diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 95326b85ff68edbda3a6661816251351029bdfda..e72d332b8316763d40e7bcfe0e32bcaa61842cf8 100644 (file)
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -9,7 +9,7 @@ git-rev-parse - Pick out and massage parameters
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git rev-parse' [ --option ] <args>...
+'git rev-parse' [<options>] <args>...

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


@@ -360,7 +360,7 @@ Example
 
 ------------
 OPTS_SPEC="\
 
 ------------
 OPTS_SPEC="\

-some-command [options] <args>...
+some-command [<options>] <args>...

 
 some-command does foo and bar!
 --
 
 some-command does foo and bar!
 --


@@ -385,7 +385,7 @@ When `"$@"` is `-h` or `--help` in the above example, the following
 usage text would be shown:
 
 ------------
 usage text would be shown:
 
 ------------

-usage: some-command [options] <args>...
+usage: some-command [<options>] <args>...

 
     some-command does foo and bar!
 
 
     some-command does foo and bar!
 

diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 464c15b94f391e9fb477b5258e7f318d5f2f14ca..4f3efde80cd8e4f0b1a5b6699ad3e569f19ca516 100644 (file)
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git send-email' [options] <file|directory|rev-list options>...
+'git send-email' [<options>] <file|directory|rev-list options>...

 'git send-email' --dump-aliases
 
 
 'git send-email' --dump-aliases
 
 

diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
index 0e1695df350b68a2739df946bbe74df7a5f9d71b..fcf528c1b30d8045592d117ccc3d5f9248d0edbd 100644 (file)
--- a/Documentation/git-show.txt
+++ b/Documentation/git-show.txt
@@ -9,7 +9,7 @@ git-show - Show various types of objects
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git show' [options] [<object>...]
+'git show' [<options>] [<object>...]

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

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index e9615951d22f724c30abdfc92485f5506a08249b..7ea24fc942c18c032048edc10dfe00b56bff991e 100644 (file)
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -8,7 +8,7 @@ git-svn - Bidirectional operation between a Subversion repository and Git
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git svn' <command> [options] [arguments]
+'git svn' <command> [<options>] [<arguments>]

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

diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
index a4ec25b450c8084f32c3a6ac920ed36c3529e54c..fd952a5ff92b72e67eac219fdfbbe5d7c708be81 100644 (file)
--- a/Documentation/git-web--browse.txt
+++ b/Documentation/git-web--browse.txt
@@ -8,7 +8,7 @@ git-web--browse - Git helper script to launch a web browser
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git web{litdd}browse' [OPTIONS] URL/FILE ...
+'git web{litdd}browse' [<options>] <url|file>...

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

diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index 9f13266a685176bf142d9e381d7a9d10ea12aa7b..592e06d839d87f28cf6cbbdcf3aa3253da2eb9f0 100644 (file)
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -110,8 +110,8 @@ couple of magic command-line options:
 +
 ---------------------------------------------
 $ git describe -h
 +
 ---------------------------------------------
 $ git describe -h

-usage: git describe [options] <commit-ish>*
-   or: git describe [options] --dirty
+usage: git describe [<options>] <commit-ish>*
+   or: git describe [<options>] --dirty

 
     --contains            find the tag that comes after the commit
     --debug               debug search strategy on stderr
 
     --contains            find the tag that comes after the commit
     --debug               debug search strategy on stderr