Make the DESCRIPTION match <x>... items in the SYNOPSIS

When the SYNOPSIS says e.g. "<path>...", it is nice if the DESCRIPTION
also mentions "<path>..." and says the specified "paths" (note plural)
are used for $whatever. This fixes the obvious mismatches.

Signed-off-by: Abhijit Menon-Sen <ams@toroid.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index 7dcc1ba58c3879cb14ce243a4af00bca9e850799..8a114509f4a19b4fa6c6d8de8afdc94938d24b82 100644 (file)
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...
+'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>...

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


@@ -16,8 +16,8 @@ Removes files unknown to git.  This allows to clean the working tree
 from files that are not under version control.  If the '-x' option is
 specified, ignored files are also removed, allowing to remove all
 build products.
 from files that are not under version control.  If the '-x' option is
 specified, ignored files are also removed, allowing to remove all
 build products.

-When optional `<paths>...` arguments are given, the paths
-affected are further limited to those that match them.
+If any optional `<path>...` arguments are given, only those paths
+are affected.

 
 
 OPTIONS
 
 
 OPTIONS

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index 7fdda04bae34790eb2345427dda746e8bf097c1a..c4dbc2ae342833561080f7a18a93bcf5ac5a0dd3 100644 (file)
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -21,8 +21,8 @@ abbreviated object name of the most recent commit.
 
 OPTIONS
 -------
 
 OPTIONS
 -------

-<committish>::
-       The object name of the committish.
+<committish>...::
+       Committish object names to describe.

 
 --all::
        Instead of using only the annotated tags, use any ref
 
 --all::
        Instead of using only the annotated tags, use any ref

diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 7ba9dab5e6c0b32f927d24de800e17b71a06b84b..a518ba6072127afce1b117a6c70022415979d079 100644 (file)
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -167,7 +167,7 @@ to other tags will be rewritten to point to the underlying commit.
        directory or when there are already refs starting with
        'refs/original/', unless forced.
 
        directory or when there are already refs starting with
        'refs/original/', unless forced.
 

-<rev-list-options>::
+<rev-list options>...::

        When options are given after the new branch name, they will
        be passed to 'git-rev-list'.  Only commits in the resulting
        output will be filtered, although the filtered commits can still
        When options are given after the new branch name, they will
        be passed to 'git-rev-list'.  Only commits in the resulting
        output will be filtered, although the filtered commits can still

diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 727d84e6735417baa82fe7abff5b6945f6d6cef4..609f9496bac7c7a9f4772aa75293bda6e5e755c5 100644 (file)
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -47,7 +47,7 @@ OPTIONS
        `xx`; for example `%00` interpolates to `\0` (NUL),
        `%09` to `\t` (TAB) and `%0a` to `\n` (LF).
 
        `xx`; for example `%00` interpolates to `\0` (NUL),
        `%09` to `\t` (TAB) and `%0a` to `\n` (LF).
 

-<pattern>::
+<pattern>...::

        If one or more patterns are given, only refs are shown that
        match againt at least one pattern, either using fnmatch(3) or
        literally, in the latter case matching completely or from the
        If one or more patterns are given, only refs are shown that
        match againt at least one pattern, either using fnmatch(3) or
        literally, in the latter case matching completely or from the

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 05cbac56aced6ad27f36fe63f8f536e794794f9f..0446bad7e589c06c97bb9274e9edd4b343ef9e55 100644 (file)
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -41,10 +41,10 @@ include::diff-options.txt[]
        Print out the ref names of any commits that are shown.
 
 --full-diff::
        Print out the ref names of any commits that are shown.
 
 --full-diff::

-       Without this flag, "git log -p <paths>..." shows commits that
+       Without this flag, "git log -p <path>..." shows commits that

        touch the specified paths, and diffs about the same specified
        paths.  With this, the full diff is shown for commits that touch
        touch the specified paths, and diffs about the same specified
        paths.  With this, the full diff is shown for commits that touch

-       the specified paths; this means that "<paths>..." limits only
+       the specified paths; this means that "<path>..." limits only

        commits, and doesn't limit diff for those commits.
 
 --follow::
        commits, and doesn't limit diff for those commits.
 
 --follow::


@@ -57,7 +57,7 @@ include::diff-options.txt[]
        Note that only message is considered, if also a diff is shown
        its size is not included.
 
        Note that only message is considered, if also a diff is shown
        its size is not included.
 

-<paths>...::
+<path>...::

        Show only commits that affect any of the specified paths.
 
 
        Show only commits that affect any of the specified paths.
 
 

diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 2db88809898592c691166427efdd106d844d42d9..17a15acb07df2d8beed4a41cdcf820010f95b35b 100644 (file)
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -32,8 +32,8 @@ include::merge-options.txt[]
        it is created). The 'git-fmt-merge-msg' script can be used
        to give a good default for automated 'git-merge' invocations.
 
        it is created). The 'git-fmt-merge-msg' script can be used
        to give a good default for automated 'git-merge' invocations.
 

-<remote>::
-       Other branch head merged into our branch.  You need at
+<remote>...::
+       Other branch heads to merge into our branch.  You need at

        least one <remote>.  Specifying more than one <remote>
        obviously means you are trying an Octopus.
 
        least one <remote>.  Specifying more than one <remote>
        obviously means you are trying an Octopus.
 

diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 9a4389981ca067633d773e28393a1d72ac6552ae..2f173fff356282df7c906da6edeac1fcd4430025 100644 (file)
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -84,7 +84,7 @@ OPTIONS
        (5) otherwise output the line.
 
 
        (5) otherwise output the line.
 
 

-<pattern>::
+<pattern>...::

 
        Show references matching one or more patterns.
 
 
        Show references matching one or more patterns.
 

diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
index 1642cfd8236a5b57420f67da580b42066afaa4f6..48b612e2ae50c319bcef567c7619f60396dd8408 100644 (file)
--- a/Documentation/git-show.txt
+++ b/Documentation/git-show.txt
@@ -33,8 +33,8 @@ This manual page describes only the most frequently used options.
 
 OPTIONS
 -------
 
 OPTIONS
 -------

-<object>::
-       The name of the object to show.
+<object>...::
+       The names of objects to show.

        For a more complete list of ways to spell object names, see
        "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
 
        For a more complete list of ways to spell object names, see
        "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
 

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 35efeefb3056ac69cf02689dc338956340e9efc9..bf33b0cba05e8858e28275661c731aae6c8372ee 100644 (file)
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -146,8 +146,8 @@ OPTIONS
        (the default). This limit only applies to modified submodules. The
        size is always limited to 1 for added/deleted/typechanged submodules.
 
        (the default). This limit only applies to modified submodules. The
        size is always limited to 1 for added/deleted/typechanged submodules.
 

-<path>::
-       Path to submodule(s). When specified this will restrict the command
+<path>...::
+       Paths to submodule(s). When specified this will restrict the command

        to only operate on the submodules found at the specified paths.
        (This argument is required with add).
 
        to only operate on the submodules found at the specified paths.
        (This argument is required with add).
 

diff --git a/Documentation/git-verify-tag.txt b/Documentation/git-verify-tag.txt
index ba837df4bc66e2b828fcd49c94f35957c27322df..84e70a02348105c98a004c080875ab8e85fe099c 100644 (file)
--- a/Documentation/git-verify-tag.txt
+++ b/Documentation/git-verify-tag.txt
@@ -15,8 +15,8 @@ Validates the gpg signature created by 'git-tag'.
 
 OPTIONS
 -------
 
 OPTIONS
 -------

-<tag>::
-       SHA1 identifier of a git tag object.
+<tag>...::
+       SHA1 identifiers of git tag objects.

 
 Author
 ------
 
 Author
 ------

diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index e02ecf57444df14d61d82dcf2f9e0c3f6b990b91..6e827cd11c6d464e1369bf1ca23af0dd53b9be32 100644 (file)
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -58,7 +58,7 @@ frequently used options.
        For a more complete list of ways to spell object names, see
        "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
 
        For a more complete list of ways to spell object names, see
        "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
 

-<path>::
+<path>...::

 
        Limit commits to the ones touching files in the given paths. Note, to
        avoid ambiguity wrt. revision names use "--" to separate the paths
 
        Limit commits to the ones touching files in the given paths. Note, to
        avoid ambiguity wrt. revision names use "--" to separate the paths