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>
Abhijit Menon-Sen committed
Jul 30, 2008 at 15:03 UTC
f448e24e2fe336621306b04b84e947bdd04f7ecc
11 files changed
+20
-20
Documentation/git-clean.txt
+3
-3
@@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
8
SYNOPSIS
9
--------
10
[verse]
11
-'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...
11
+'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>...
12
13
DESCRIPTION
14
-----------
@@ -16,8 +16,8 @@ Removes files unknown to git. This allows to clean the working tree
16
from files that are not under version control. If the '-x' option is
17
specified, ignored files are also removed, allowing to remove all
18
build products.
19
-When optional `<paths>...` arguments are given, the paths
20
-affected are further limited to those that match them.
19
+If any optional `<path>...` arguments are given, only those paths
20
+are affected.
21
22
23
OPTIONS
Documentation/git-describe.txt
+2
-2
@@ -21,8 +21,8 @@ abbreviated object name of the most recent commit.
21
22
OPTIONS
23
-------
24
-<committish>::
25
- The object name of the committish.
24
+<committish>...::
25
+ Committish object names to describe.
26
27
--all::
28
Instead of using only the annotated tags, use any ref
Documentation/git-filter-branch.txt
+1
-1
@@ -167,7 +167,7 @@ to other tags will be rewritten to point to the underlying commit.
167
directory or when there are already refs starting with
168
'refs/original/', unless forced.
169
170
-<rev-list-options>::
170
+<rev-list options>...::
171
When options are given after the new branch name, they will
172
be passed to 'git-rev-list'. Only commits in the resulting
173
output will be filtered, although the filtered commits can still
Documentation/git-for-each-ref.txt
+1
-1
@@ -47,7 +47,7 @@ OPTIONS
47
`xx`; for example `%00` interpolates to `\0` (NUL),
48
`%09` to `\t` (TAB) and `%0a` to `\n` (LF).
49
50
-<pattern>::
50
+<pattern>...::
51
If one or more patterns are given, only refs are shown that
52
match againt at least one pattern, either using fnmatch(3) or
53
literally, in the latter case matching completely or from the
Documentation/git-log.txt
+3
-3
@@ -41,10 +41,10 @@ include::diff-options.txt[]
41
Print out the ref names of any commits that are shown.
42
43
--full-diff::
44
- Without this flag, "git log -p <paths>..." shows commits that
44
+ Without this flag, "git log -p <path>..." shows commits that
45
touch the specified paths, and diffs about the same specified
46
paths. With this, the full diff is shown for commits that touch
47
- the specified paths; this means that "<paths>..." limits only
47
+ the specified paths; this means that "<path>..." limits only
48
commits, and doesn't limit diff for those commits.
49
50
--follow::
@@ -57,7 +57,7 @@ include::diff-options.txt[]
57
Note that only message is considered, if also a diff is shown
58
its size is not included.
59
60
-<paths>...::
60
+<path>...::
61
Show only commits that affect any of the specified paths.
62
63
Documentation/git-merge.txt
+2
-2
@@ -32,8 +32,8 @@ include::merge-options.txt[]
32
it is created). The 'git-fmt-merge-msg' script can be used
33
to give a good default for automated 'git-merge' invocations.
34
35
-<remote>::
36
- Other branch head merged into our branch. You need at
35
+<remote>...::
36
+ Other branch heads to merge into our branch. You need at
37
least one <remote>. Specifying more than one <remote>
38
obviously means you are trying an Octopus.
39
Documentation/git-show-ref.txt
+1
-1
@@ -84,7 +84,7 @@ OPTIONS
84
(5) otherwise output the line.
85
86
87
-<pattern>::
87
+<pattern>...::
88
89
Show references matching one or more patterns.
90
Documentation/git-show.txt
+2
-2
@@ -33,8 +33,8 @@ This manual page describes only the most frequently used options.
33
34
OPTIONS
35
-------
36
-<object>::
37
- The name of the object to show.
36
+<object>...::
37
+ The names of objects to show.
38
For a more complete list of ways to spell object names, see
39
"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
40
Documentation/git-submodule.txt
+2
-2
@@ -146,8 +146,8 @@ OPTIONS
146
(the default). This limit only applies to modified submodules. The
147
size is always limited to 1 for added/deleted/typechanged submodules.
148
149
-<path>::
150
- Path to submodule(s). When specified this will restrict the command
149
+<path>...::
150
+ Paths to submodule(s). When specified this will restrict the command
151
to only operate on the submodules found at the specified paths.
152
(This argument is required with add).
153
Documentation/git-verify-tag.txt
+2
-2
@@ -15,8 +15,8 @@ Validates the gpg signature created by 'git-tag'.
15
16
OPTIONS
17
-------
18
-<tag>::
19
- SHA1 identifier of a git tag object.
18
+<tag>...::
19
+ SHA1 identifiers of git tag objects.
20
21
Author
22
------
Documentation/gitk.txt
+1
-1
@@ -58,7 +58,7 @@ frequently used options.
58
For a more complete list of ways to spell object names, see
59
"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
60
61
-<path>::
61
+<path>...::
62
63
Limit commits to the ones touching files in the given paths. Note, to
64
avoid ambiguity wrt. revision names use "--" to separate the paths