git-for-each-ref.txt: minor improvements
Rewrapped synopsis and removed wrong asterisk behind --count option; clarified --sort=<key> description for multiple keys; documented that for-each-ref supports not only glob patterns but also prefixes like "refs/heads" as patterns, and that multiple patterns can be given. Signed-off-by: Lea Wiemann <LeWiemann@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Lea Wiemann committed
Jun 5, 2008 at 23:01 UTC
c0f6dc9b20523a569e567d3be4cabbc949c71b43
1 file changed
+9
-8
Documentation/git-for-each-ref.txt
+9
-8
@@ -8,9 +8,8 @@ git-for-each-ref - Output information on each ref
8
SYNOPSIS
9
--------
10
[verse]
11
-'git-for-each-ref' [--count=<count>]\*
12
- [--shell|--perl|--python|--tcl]
13
- [--sort=<key>]\* [--format=<format>] [<pattern>]
11
+'git-for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
12
+ [--sort=<key>]\* [--format=<format>] [<pattern>...]
13
14
DESCRIPTION
15
-----------
@@ -32,8 +31,9 @@ OPTIONS
31
<key>::
32
A field name to sort on. Prefix `-` to sort in
33
descending order of the value. When unspecified,
35
- `refname` is used. More than one sort keys can be
36
- given.
34
+ `refname` is used. You may use the --sort=<key> option
35
+ multiple times, in which case the last key becomes the primary
36
+ key.
37
38
<format>::
39
A string that interpolates `%(fieldname)` from the
@@ -48,9 +48,10 @@ OPTIONS
48
`%09` to `\t` (TAB) and `%0a` to `\n` (LF).
49
50
<pattern>::
51
- If given, the name of the ref is matched against this
52
- using fnmatch(3). Refs that do not match the pattern
53
- are not shown.
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
54
+ beginning up to a slash.
55
56
--shell, --perl, --python, --tcl::
57
If given, strings that substitute `%(fieldname)`