Merge branch 'maint'
[git/mingw.git] / Documentation / git-for-each-ref.txt
blobdb55a4e0bbc524c20f08e6862daaa97dd1785b71
1 git-for-each-ref(1)
2 ===================
4 NAME
5 ----
6 git-for-each-ref - Output information on each ref
8 SYNOPSIS
9 --------
10 [verse]
11 'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
12                    [(--sort=<key>)...] [--format=<format>] [<pattern>...]
14 DESCRIPTION
15 -----------
17 Iterate over all refs that match `<pattern>` and show them
18 according to the given `<format>`, after sorting them according
19 to the given set of `<key>`.  If `<count>` is given, stop after
20 showing that many refs.  The interpolated values in `<format>`
21 can optionally be quoted as string literals in the specified
22 host language allowing their direct evaluation in that language.
24 OPTIONS
25 -------
26 <count>::
27         By default the command shows all refs that match
28         `<pattern>`.  This option makes it stop after showing
29         that many refs.
31 <key>::
32         A field name to sort on.  Prefix `-` to sort in
33         descending order of the value.  When unspecified,
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.
38 <format>::
39         A string that interpolates `%(fieldname)` from the
40         object pointed at by a ref being shown.  If `fieldname`
41         is prefixed with an asterisk (`*`) and the ref points
42         at a tag object, the value for the field in the object
43         tag refers is used.  When unspecified, defaults to
44         `%(objectname) SPC %(objecttype) TAB %(refname)`.
45         It also interpolates `%%` to `%`, and `%xx` where `xx`
46         are hex digits interpolates to character with hex code
47         `xx`; for example `%00` interpolates to `\0` (NUL),
48         `%09` to `\t` (TAB) and `%0a` to `\n` (LF).
50 <pattern>...::
51         If one or more patterns are given, only refs are shown that
52         match against 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.
56 --shell::
57 --perl::
58 --python::
59 --tcl::
60         If given, strings that substitute `%(fieldname)`
61         placeholders are quoted as string literals suitable for
62         the specified host language.  This is meant to produce
63         a scriptlet that can directly be `eval`ed.
66 FIELD NAMES
67 -----------
69 Various values from structured fields in referenced objects can
70 be used to interpolate into the resulting output, or as sort
71 keys.
73 For all objects, the following names can be used:
75 refname::
76         The name of the ref (the part after $GIT_DIR/).
77         For a non-ambiguous short name of the ref append `:short`.
78         The option core.warnAmbiguousRefs is used to select the strict
79         abbreviation mode.
81 objecttype::
82         The type of the object (`blob`, `tree`, `commit`, `tag`).
84 objectsize::
85         The size of the object (the same as 'git cat-file -s' reports).
87 objectname::
88         The object name (aka SHA-1).
89         For a non-ambiguous abbreviation of the object name append `:short`.
91 upstream::
92         The name of a local ref which can be considered ``upstream''
93         from the displayed ref. Respects `:short` in the same way as
94         `refname` above.
96 In addition to the above, for commit and tag objects, the header
97 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
98 be used to specify the value in the header field.
100 Fields that have name-email-date tuple as its value (`author`,
101 `committer`, and `tagger`) can be suffixed with `name`, `email`,
102 and `date` to extract the named component.
104 The complete message in a commit and tag object is `contents`.
105 Its first line is `contents:subject`, where subject is the concatenation
106 of all lines of the commit message up to the first blank line.  The next
107 line is 'contents:body', where body is all of the lines after the first
108 blank line.  Finally, the optional GPG signature is `contents:signature`.
110 For sorting purposes, fields with numeric values sort in numeric
111 order (`objectsize`, `authordate`, `committerdate`, `taggerdate`).
112 All other fields are used to sort in their byte-value order.
114 In any case, a field name that refers to a field inapplicable to
115 the object referred by the ref does not cause an error.  It
116 returns an empty string instead.
118 As a special case for the date-type fields, you may specify a format for
119 the date by adding one of `:default`, `:relative`, `:short`, `:local`,
120 `:iso8601` or `:rfc2822` to the end of the fieldname; e.g.
121 `%(taggerdate:relative)`.
124 EXAMPLES
125 --------
127 An example directly producing formatted text.  Show the most recent
128 3 tagged commits:
130 ------------
131 #!/bin/sh
133 git for-each-ref --count=3 --sort='-*authordate' \
134 --format='From: %(*authorname) %(*authoremail)
135 Subject: %(*subject)
136 Date: %(*authordate)
137 Ref: %(*refname)
139 %(*body)
140 ' 'refs/tags'
141 ------------
144 A simple example showing the use of shell eval on the output,
145 demonstrating the use of --shell.  List the prefixes of all heads:
146 ------------
147 #!/bin/sh
149 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
150 while read entry
152         eval "$entry"
153         echo `dirname $ref`
154 done
155 ------------
158 A bit more elaborate report on tags, demonstrating that the format
159 may be an entire script:
160 ------------
161 #!/bin/sh
163 fmt='
164         r=%(refname)
165         t=%(*objecttype)
166         T=${r#refs/tags/}
168         o=%(*objectname)
169         n=%(*authorname)
170         e=%(*authoremail)
171         s=%(*subject)
172         d=%(*authordate)
173         b=%(*body)
175         kind=Tag
176         if test "z$t" = z
177         then
178                 # could be a lightweight tag
179                 t=%(objecttype)
180                 kind="Lightweight tag"
181                 o=%(objectname)
182                 n=%(authorname)
183                 e=%(authoremail)
184                 s=%(subject)
185                 d=%(authordate)
186                 b=%(body)
187         fi
188         echo "$kind $T points at a $t object $o"
189         if test "z$t" = zcommit
190         then
191                 echo "The commit was authored by $n $e
192 at $d, and titled
194     $s
196 Its message reads as:
198                 echo "$b" | sed -e "s/^/    /"
199                 echo
200         fi
203 eval=`git for-each-ref --shell --format="$fmt" \
204         --sort='*objecttype' \
205         --sort=-taggerdate \
206         refs/tags`
207 eval "$eval"
208 ------------
210 Author
211 ------
212 Written by Junio C Hamano <gitster@pobox.com>.
214 Documentation
215 -------------
216 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
220 Part of the linkgit:git[1] suite