From f448e24e2fe336621306b04b84e947bdd04f7ecc Mon Sep 17 00:00:00 2001 From: Abhijit Menon-Sen Date: Wed, 30 Jul 2008 15:03:43 +0530 Subject: [PATCH] Make the DESCRIPTION match ... items in the SYNOPSIS When the SYNOPSIS says e.g. "...", it is nice if the DESCRIPTION also mentions "..." and says the specified "paths" (note plural) are used for $whatever. This fixes the obvious mismatches. Signed-off-by: Abhijit Menon-Sen Signed-off-by: Junio C Hamano --- Documentation/git-clean.txt | 6 +++--- Documentation/git-describe.txt | 4 ++-- Documentation/git-filter-branch.txt | 2 +- Documentation/git-for-each-ref.txt | 2 +- Documentation/git-log.txt | 6 +++--- Documentation/git-merge.txt | 4 ++-- Documentation/git-show-ref.txt | 2 +- Documentation/git-show.txt | 4 ++-- Documentation/git-submodule.txt | 4 ++-- Documentation/git-verify-tag.txt | 4 ++-- Documentation/gitk.txt | 2 +- 11 files changed, 20 insertions(+), 20 deletions(-) diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 7dcc1ba58c..8a114509f4 100644 --- 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] -'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] ... +'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] ... 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. -When optional `...` arguments are given, the paths -affected are further limited to those that match them. +If any optional `...` arguments are given, only those paths +are affected. OPTIONS diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 7fdda04bae..c4dbc2ae34 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -21,8 +21,8 @@ abbreviated object name of the most recent commit. OPTIONS ------- -:: - The object name of the 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 index 7ba9dab5e6..a518ba6072 100644 --- 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. -:: +...:: 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 727d84e673..609f9496ba 100644 --- 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). -:: +...:: 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 05cbac56ac..0446bad7e5 100644 --- 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 ..." shows commits that + Without this flag, "git log -p ..." 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 "..." limits only + the specified paths; this means that "..." 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. -...:: +...:: Show only commits that affect any of the specified paths. diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index 2db8880989..17a15acb07 100644 --- 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. -:: - Other branch head merged into our branch. You need at +...:: + Other branch heads to merge into our branch. You need at least one . Specifying more than one obviously means you are trying an Octopus. diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index 9a4389981c..2f173fff35 100644 --- a/Documentation/git-show-ref.txt +++ b/Documentation/git-show-ref.txt @@ -84,7 +84,7 @@ OPTIONS (5) otherwise output the line. -:: +...:: Show references matching one or more patterns. diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt index 1642cfd823..48b612e2ae 100644 --- 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 ------- -:: - 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 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 35efeefb30..bf33b0cba0 100644 --- 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 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. (This argument is required with add). diff --git a/Documentation/git-verify-tag.txt b/Documentation/git-verify-tag.txt index ba837df4bc..84e70a0234 100644 --- 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 ------- -:: - SHA1 identifier of a git tag object. +...:: + SHA1 identifiers of git tag objects. Author ------ diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index e02ecf5744..6e827cd11c 100644 --- 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]. -:: +...:: Limit commits to the ones touching files in the given paths. Note, to avoid ambiguity wrt. revision names use "--" to separate the paths -- GitLab