undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Abhijit Menon-Sen 2008-07-30 15:03:43 +05:30 committed by Junio C Hamano
parent 0e25790f1d
commit f448e24e2f
11 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/git-clean.txt
View File

@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
SYNOPSIS SYNOPSIS
-------- --------
[verse] [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 from files that are not under version control. If the '-x' option is
specified, ignored files are also removed, allowing to remove all specified, ignored files are also removed, allowing to remove all
build products. build products.
When optional `<paths>...` arguments are given, the paths If any optional `<path>...` arguments are given, only those paths
affected are further limited to those that match them. are affected.
OPTIONS OPTIONS

4
Documentation/git-describe.txt
View File

@ -21,8 +21,8 @@ abbreviated object name of the most recent commit.
OPTIONS OPTIONS
------- -------
<committish>:: <committish>...::
The object name of the committish. Committish object names to describe.
--all:: --all::
Instead of using only the annotated tags, use any ref Instead of using only the annotated tags, use any ref

2
Documentation/git-filter-branch.txt
View File

@ -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 directory or when there are already refs starting with
'refs/original/', unless forced. 'refs/original/', unless forced.
<rev-list-options>:: <rev-list options>...::
When options are given after the new branch name, they will When options are given after the new branch name, they will
be passed to 'git-rev-list'. Only commits in the resulting be passed to 'git-rev-list'. Only commits in the resulting
output will be filtered, although the filtered commits can still output will be filtered, although the filtered commits can still

2
Documentation/git-for-each-ref.txt
View File

@ -47,7 +47,7 @@ OPTIONS
`xx`; for example `%00` interpolates to `\0` (NUL), `xx`; for example `%00` interpolates to `\0` (NUL),
`%09` to `\t` (TAB) and `%0a` to `\n` (LF). `%09` to `\t` (TAB) and `%0a` to `\n` (LF).
<pattern>:: <pattern>...::
If one or more patterns are given, only refs are shown that If one or more patterns are given, only refs are shown that
match againt at least one pattern, either using fnmatch(3) or match againt at least one pattern, either using fnmatch(3) or
literally, in the latter case matching completely or from the literally, in the latter case matching completely or from the

6
Documentation/git-log.txt
View File

@ -41,10 +41,10 @@ include::diff-options.txt[]
Print out the ref names of any commits that are shown. Print out the ref names of any commits that are shown.
--full-diff:: --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 touch the specified paths, and diffs about the same specified
paths. With this, the full diff is shown for commits that touch 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. commits, and doesn't limit diff for those commits.
--follow:: --follow::
@ -57,7 +57,7 @@ include::diff-options.txt[]
Note that only message is considered, if also a diff is shown Note that only message is considered, if also a diff is shown
its size is not included. 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.

4
Documentation/git-merge.txt
View File

@ -32,8 +32,8 @@ include::merge-options.txt[]
it is created). The 'git-fmt-merge-msg' script can be used it is created). The 'git-fmt-merge-msg' script can be used
to give a good default for automated 'git-merge' invocations. to give a good default for automated 'git-merge' invocations.
<remote>:: <remote>...::
Other branch head merged into our branch. You need at Other branch heads to merge into our branch. You need at
least one <remote>. Specifying more than one <remote> least one <remote>. Specifying more than one <remote>
obviously means you are trying an Octopus. obviously means you are trying an Octopus.

2
Documentation/git-show-ref.txt
View File

@ -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.

4
Documentation/git-show.txt
View File

@ -33,8 +33,8 @@ This manual page describes only the most frequently used options.
OPTIONS OPTIONS
------- -------
<object>:: <object>...::
The name of the object to show. The names of objects to show.
For a more complete list of ways to spell object names, see For a more complete list of ways to spell object names, see
"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].

4
Documentation/git-submodule.txt
View File

@ -146,8 +146,8 @@ OPTIONS
(the default). This limit only applies to modified submodules. The (the default). This limit only applies to modified submodules. The
size is always limited to 1 for added/deleted/typechanged submodules. size is always limited to 1 for added/deleted/typechanged submodules.
<path>:: <path>...::
Path to submodule(s). When specified this will restrict the command Paths to submodule(s). When specified this will restrict the command
to only operate on the submodules found at the specified paths. to only operate on the submodules found at the specified paths.
(This argument is required with add). (This argument is required with add).

4
Documentation/git-verify-tag.txt
View File

@ -15,8 +15,8 @@ Validates the gpg signature created by 'git-tag'.
OPTIONS OPTIONS
------- -------
<tag>:: <tag>...::
SHA1 identifier of a git tag object. SHA1 identifiers of git tag objects.
Author Author
------ ------

2
Documentation/gitk.txt
View File

@ -58,7 +58,7 @@ frequently used options.
For a more complete list of ways to spell object names, see For a more complete list of ways to spell object names, see
"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
<path>:: <path>...::
Limit commits to the ones touching files in the given paths. Note, to Limit commits to the ones touching files in the given paths. Note, to
avoid ambiguity wrt. revision names use "--" to separate the paths avoid ambiguity wrt. revision names use "--" to separate the paths