Skip to content

Commit

Permalink
git-for-each-ref.txt: minor improvements
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Lea Wiemann authored and Junio C Hamano committed Jun 6, 2008
1 parent a83123d commit c0f6dc9
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions Documentation/git-for-each-ref.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ git-for-each-ref - Output information on each ref
SYNOPSIS
--------
[verse]
'git-for-each-ref' [--count=<count>]\*
[--shell|--perl|--python|--tcl]
[--sort=<key>]\* [--format=<format>] [<pattern>]
'git-for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
[--sort=<key>]\* [--format=<format>] [<pattern>...]

DESCRIPTION
-----------
Expand All @@ -32,8 +31,9 @@ OPTIONS
<key>::
A field name to sort on. Prefix `-` to sort in
descending order of the value. When unspecified,
`refname` is used. More than one sort keys can be
given.
`refname` is used. You may use the --sort=<key> option
multiple times, in which case the last key becomes the primary
key.

<format>::
A string that interpolates `%(fieldname)` from the
Expand All @@ -48,9 +48,10 @@ OPTIONS
`%09` to `\t` (TAB) and `%0a` to `\n` (LF).

<pattern>::
If given, the name of the ref is matched against this
using fnmatch(3). Refs that do not match the pattern
are not shown.
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
beginning up to a slash.

--shell, --perl, --python, --tcl::
If given, strings that substitute `%(fieldname)`
Expand Down

0 comments on commit c0f6dc9

Please sign in to comment.