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

amenonsen · gitster · commit f448e24e2fe3 · 2008-07-30T21:42:55.000-07:00
When the SYNOPSIS says e.g. "&lt;path&gt;...", it is nice if the DESCRIPTION
also mentions "&lt;path&gt;..." and says the specified "paths" (note plural)
are used for $whatever. This fixes the obvious mismatches.

Signed-off-by: Abhijit Menon-Sen &lt;ams@toroid.org&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
@@ -8,16 +8,16 @@ git-clean - Remove untracked files from the working tree
 SYNOPSIS
 --------
 [verse]
-'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...
+'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>...
 
 DESCRIPTION
 -----------
 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.
-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
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
@@ -21,8 +21,8 @@ abbreviated object name of the most recent commit.
 
 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
diff --git 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.
 
-<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
diff --git 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).
 
-<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
diff --git 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::
-	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
-	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::
@@ -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.
 
-<paths>...::
+<path>...::
 	Show only commits that affect any of the specified paths.
 
 
diff --git 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.
 
-<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.
 
diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
@@ -84,7 +84,7 @@ OPTIONS
 	(5) otherwise output the line.
 
 
-<pattern>::
+<pattern>...::
 
 	Show references matching one or more patterns.
 
diff --git 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
 -------
-<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].
 
diff --git 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.
 
-<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).
 
diff --git 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
 -------
-<tag>::
-	SHA1 identifier of a git tag object.
+<tag>...::
+	SHA1 identifiers of git tag objects.
 
 Author
 ------
diff --git 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].
 
-<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
