Merge branch 'maint'

[git.git] / Documentation / git-for-each-ref.txt

diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 2bf6aef73522e3ba7e5212d3eb1bce02a257e069..f1f90cca62f61327a13b5ab41862596ca24a9b8f 100644 (file)
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -7,7 +7,10 @@ git-for-each-ref - Output information on each ref
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-for-each-ref' [--count=<count>]\* [--shell|--perl|--python] [--sort=<key>]\* [--format=<format>] [<pattern>]
+[verse]
+'git-for-each-ref' [--count=<count>]\*
+                   [--shell|--perl|--python|--tcl]
+                   [--sort=<key>]\* [--format=<format>] [<pattern>]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -15,7 +18,7 @@ DESCRIPTION
 Iterate over all refs that match `<pattern>` and show them
 according to the given `<format>`, after sorting them according
 to the given set of `<key>`.  If `<max>` is given, stop after
 Iterate over all refs that match `<pattern>` and show them
 according to the given `<format>`, after sorting them according
 to the given set of `<key>`.  If `<max>` is given, stop after

-showing that many refs.  The interporated values in `<format>`
+showing that many refs.  The interpolated values in `<format>`

 can optionally be quoted as string literals in the specified
 host language allowing their direct evaluation in that language.
 
 can optionally be quoted as string literals in the specified
 host language allowing their direct evaluation in that language.
 


@@ -49,7 +52,7 @@ OPTIONS
        using fnmatch(3).  Refs that do not match the pattern
        are not shown.
 
        using fnmatch(3).  Refs that do not match the pattern
        are not shown.
 

---shell, --perl, --python::
+--shell, --perl, --python, --tcl::

        If given, strings that substitute `%(fieldname)`
        placeholders are quoted as string literals suitable for
        the specified host language.  This is meant to produce
        If given, strings that substitute `%(fieldname)`
        placeholders are quoted as string literals suitable for
        the specified host language.  This is meant to produce


@@ -66,7 +69,7 @@ keys.
 For all objects, the following names can be used:
 
 refname::
 For all objects, the following names can be used:
 
 refname::

-       The name of the ref (the part after $GIT_DIR/refs/).
+       The name of the ref (the part after $GIT_DIR/).

 
 objecttype::
        The type of the object (`blob`, `tree`, `commit`, `tag`).
 
 objecttype::
        The type of the object (`blob`, `tree`, `commit`, `tag`).


@@ -97,6 +100,11 @@ In any case, a field name that refers to a field inapplicable to
 the object referred by the ref does not cause an error.  It
 returns an empty string instead.
 
 the object referred by the ref does not cause an error.  It
 returns an empty string instead.
 

+As a special case for the date-type fields, you may specify a format for
+the date by adding one of `:default`, `:relative`, `:short`, `:local`,
+`:iso8601` or `:rfc2822` to the end of the fieldname; e.g.
+`%(taggerdate:relative)`.
+

 
 EXAMPLES
 --------
 
 EXAMPLES
 --------