From: Kevin Daudt <me@ikke.info>
To: git@vger.kernel.org
Cc: Kevin Daudt <me@ikke.info>
Subject: [PATCH] doc/for-each-ref: explicitly specify option names
Date: Fri, 1 Sep 2017 16:49:31 +0200 [thread overview]
Message-ID: <20170901144931.26114-1-me@ikke.info> (raw)
For count, sort and format, only the argument names were listed under
OPTIONS, not the option names.
Add the option names to make it clear the options exist
Signed-off-by: Kevin Daudt <me@ikke.info>
---
Documentation/git-for-each-ref.txt | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index bb370c9c7..0c2032855 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -25,19 +25,25 @@ host language allowing their direct evaluation in that language.
OPTIONS
-------
-<count>::
+<pattern>...::
+ If one or more patterns are given, only refs are shown that
+ match against at least one pattern, either using fnmatch(3) or
+ literally, in the latter case matching completely or from the
+ beginning up to a slash.
+
+--count <count>::
By default the command shows all refs that match
`<pattern>`. This option makes it stop after showing
that many refs.
-<key>::
+--sort <key>::
A field name to sort on. Prefix `-` to sort in
descending order of the value. When unspecified,
`refname` is used. You may use the --sort=<key> option
multiple times, in which case the last key becomes the primary
key.
-<format>::
+--format <format>::
A string that interpolates `%(fieldname)` from a ref being shown
and the object it points at. If `fieldname`
is prefixed with an asterisk (`*`) and the ref points
@@ -50,12 +56,6 @@ OPTIONS
`xx`; for example `%00` interpolates to `\0` (NUL),
`%09` to `\t` (TAB) and `%0a` to `\n` (LF).
-<pattern>...::
- If one or more patterns are given, only refs are shown that
- match against at least one pattern, either using fnmatch(3) or
- literally, in the latter case matching completely or from the
- beginning up to a slash.
-
--shell::
--perl::
--python::
--
2.14.1.459.g238e487ea9
next reply other threads:[~2017-09-01 14:50 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-01 14:49 Kevin Daudt [this message]
2017-09-01 22:03 ` [PATCH] doc/for-each-ref: explicitly specify option names Jeff King
2017-09-01 23:03 ` Johannes Schindelin
2017-09-01 23:19 ` Jonathan Nieder
2017-09-02 2:03 ` Junio C Hamano
2017-09-11 19:33 ` [PATCH v2 1/2] doc/for-each-ref: consistently use '=' to between argument names and values Kevin Daudt
2017-09-11 19:33 ` [PATCH v2 2/2] doc/for-each-ref: explicitly specify option names Kevin Daudt
2017-09-12 2:28 ` [PATCH v2 1/2] doc/for-each-ref: consistently use '=' to between argument names and values Junio C Hamano
2017-09-12 4:38 ` Kevin Daudt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170901144931.26114-1-me@ikke.info \
--to=me@ikke.info \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).