doc/for-each-ref: explicitly specify option names
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Kevin Daudt committed
Sep 11, 2017 at 21:33 UTC
f7a32dd97fc4aba86ee8982bbe05eabf78129e65
1 file changed
+9
-9
Documentation/git-for-each-ref.txt
+9
-9
@@ -26,19 +26,25 @@ host language allowing their direct evaluation in that language.
26
27
OPTIONS
28
-------
29
-<count>::
29
+<pattern>...::
30
+ If one or more patterns are given, only refs are shown that
31
+ match against at least one pattern, either using fnmatch(3) or
32
+ literally, in the latter case matching completely or from the
33
+ beginning up to a slash.
34
+
35
+--count=<count>::
36
By default the command shows all refs that match
37
`<pattern>`. This option makes it stop after showing
38
that many refs.
39
34
-<key>::
40
+--sort=<key>::
41
A field name to sort on. Prefix `-` to sort in
42
descending order of the value. When unspecified,
43
`refname` is used. You may use the --sort=<key> option
44
multiple times, in which case the last key becomes the primary
45
key.
46
41
-<format>::
47
+--format=<format>::
48
A string that interpolates `%(fieldname)` from a ref being shown
49
and the object it points at. If `fieldname`
50
is prefixed with an asterisk (`*`) and the ref points
@@ -51,12 +57,6 @@ OPTIONS
57
`xx`; for example `%00` interpolates to `\0` (NUL),
58
`%09` to `\t` (TAB) and `%0a` to `\n` (LF).
59
54
-<pattern>...::
55
- If one or more patterns are given, only refs are shown that
56
- match against at least one pattern, either using fnmatch(3) or
57
- literally, in the latter case matching completely or from the
58
- beginning up to a slash.
59
-
60
--shell::
61
--perl::
62
--python::