diff options
| author | Lea Wiemann <lewiemann@gmail.com> | 2008-06-05 23:01:38 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-06-06 08:39:54 -0700 |
| commit | c0f6dc9b20523a569e567d3be4cabbc949c71b43 (patch) | |
| tree | 4c2988d90aa1898ca8c26ffbf018219132f14df7 | |
| parent | a83123deecfdd5078c2e16166576fb17add194b2 (diff) | |
| download | git-c0f6dc9b20523a569e567d3be4cabbc949c71b43.tar.gz git-c0f6dc9b20523a569e567d3be4cabbc949c71b43.tar.xz | |
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>
| -rw-r--r-- | Documentation/git-for-each-ref.txt | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt index f1f90cca6..6325ff9a6 100644 --- a/Documentation/git-for-each-ref.txt +++ b/Documentation/git-for-each-ref.txt @@ -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)` |