development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-27 19:49:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

git-for-each-ref.txt: minor improvements

Browse source 
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>
This commit is contained in:
Lea Wiemann 2008-06-05 23:01:38 +02:00 committed by Junio C Hamano
parent a83123deec
commit c0f6dc9b20
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
Documentation/git-for-each-ref.txt
View file

@ -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
-----------
@ -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
@ -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)`