]>
Commit | Line | Data |
---|---|---|
9f613ddd JH |
1 | git-for-each-ref(1) |
2 | =================== | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-for-each-ref - Output information on each ref | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
97925fde | 10 | [verse] |
b1889c36 | 11 | 'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl] |
0adda936 | 12 | [(--sort=<key>)...] [--format=<format>] [<pattern>...] |
7c328348 | 13 | [--points-at <object>] [(--merged | --no-merged) [<object>]] |
ac3f5a34 | 14 | [--contains [<object>]] [--no-contains [<object>]] |
9f613ddd JH |
15 | |
16 | DESCRIPTION | |
17 | ----------- | |
18 | ||
19 | Iterate over all refs that match `<pattern>` and show them | |
20 | according to the given `<format>`, after sorting them according | |
d4040e0a | 21 | to the given set of `<key>`. If `<count>` is given, stop after |
23bfbb81 | 22 | showing that many refs. The interpolated values in `<format>` |
9f613ddd | 23 | can optionally be quoted as string literals in the specified |
1729fa98 | 24 | host language allowing their direct evaluation in that language. |
9f613ddd JH |
25 | |
26 | OPTIONS | |
27 | ------- | |
28 | <count>:: | |
29 | By default the command shows all refs that match | |
30 | `<pattern>`. This option makes it stop after showing | |
31 | that many refs. | |
32 | ||
33 | <key>:: | |
34 | A field name to sort on. Prefix `-` to sort in | |
35 | descending order of the value. When unspecified, | |
c0f6dc9b LW |
36 | `refname` is used. You may use the --sort=<key> option |
37 | multiple times, in which case the last key becomes the primary | |
38 | key. | |
9f613ddd JH |
39 | |
40 | <format>:: | |
e4933cee MG |
41 | A string that interpolates `%(fieldname)` from a ref being shown |
42 | and the object it points at. If `fieldname` | |
9f613ddd | 43 | is prefixed with an asterisk (`*`) and the ref points |
794b7e16 MG |
44 | at a tag object, use the value for the field in the object |
45 | which the tag object refers to (instead of the field in the tag object). | |
46 | When unspecified, `<format>` defaults to | |
ba7545ad JN |
47 | `%(objectname) SPC %(objecttype) TAB %(refname)`. |
48 | It also interpolates `%%` to `%`, and `%xx` where `xx` | |
49 | are hex digits interpolates to character with hex code | |
50 | `xx`; for example `%00` interpolates to `\0` (NUL), | |
51 | `%09` to `\t` (TAB) and `%0a` to `\n` (LF). | |
9f613ddd | 52 | |
f448e24e | 53 | <pattern>...:: |
c0f6dc9b | 54 | If one or more patterns are given, only refs are shown that |
1168d402 | 55 | match against at least one pattern, either using fnmatch(3) or |
c0f6dc9b LW |
56 | literally, in the latter case matching completely or from the |
57 | beginning up to a slash. | |
9f613ddd | 58 | |
3240240f SB |
59 | --shell:: |
60 | --perl:: | |
61 | --python:: | |
62 | --tcl:: | |
9f613ddd JH |
63 | If given, strings that substitute `%(fieldname)` |
64 | placeholders are quoted as string literals suitable for | |
65 | the specified host language. This is meant to produce | |
66 | a scriptlet that can directly be `eval`ed. | |
67 | ||
d325406e KN |
68 | --points-at <object>:: |
69 | Only list refs which points at the given object. | |
9f613ddd | 70 | |
7c328348 KN |
71 | --merged [<object>]:: |
72 | Only list refs whose tips are reachable from the | |
17d6c744 ÆAB |
73 | specified commit (HEAD if not specified), |
74 | incompatible with `--no-merged`. | |
7c328348 KN |
75 | |
76 | --no-merged [<object>]:: | |
77 | Only list refs whose tips are not reachable from the | |
17d6c744 ÆAB |
78 | specified commit (HEAD if not specified), |
79 | incompatible with `--merged`. | |
7c328348 | 80 | |
4a71109a | 81 | --contains [<object>]:: |
8b5a3e98 | 82 | Only list refs which contain the specified commit (HEAD if not |
4a71109a KN |
83 | specified). |
84 | ||
ac3f5a34 ÆAB |
85 | --no-contains [<object>]:: |
86 | Only list refs which don't contain the specified commit (HEAD | |
87 | if not specified). | |
88 | ||
3bb16a8b NTND |
89 | --ignore-case:: |
90 | Sorting and filtering refs are case insensitive. | |
91 | ||
9f613ddd JH |
92 | FIELD NAMES |
93 | ----------- | |
94 | ||
95 | Various values from structured fields in referenced objects can | |
96 | be used to interpolate into the resulting output, or as sort | |
97 | keys. | |
98 | ||
99 | For all objects, the following names can be used: | |
100 | ||
101 | refname:: | |
69057cf3 | 102 | The name of the ref (the part after $GIT_DIR/). |
7d66f21a | 103 | For a non-ambiguous short name of the ref append `:short`. |
2bb98169 | 104 | The option core.warnAmbiguousRefs is used to select the strict |
1a34728e KN |
105 | abbreviation mode. If `lstrip=<N>` (`rstrip=<N>`) is appended, strips `<N>` |
106 | slash-separated path components from the front (back) of the refname | |
107 | (e.g. `%(refname:lstrip=2)` turns `refs/tags/foo` into `foo` and | |
108 | `%(refname:rstrip=2)` turns `refs/tags/foo` into `refs`). | |
1a0ca5e3 | 109 | If `<N>` is a negative number, strip as many path components as |
1a34728e | 110 | necessary from the specified end to leave `-<N>` path components |
1a0ca5e3 | 111 | (e.g. `%(refname:lstrip=-2)` turns |
1a34728e KN |
112 | `refs/tags/foo` into `tags/foo` and `%(refname:rstrip=-1)` |
113 | turns `refs/tags/foo` into `refs`). When the ref does not have | |
1a0ca5e3 KN |
114 | enough components, the result becomes an empty string if |
115 | stripping with positive <N>, or it becomes the full refname if | |
116 | stripping with negative <N>. Neither is an error. | |
44a6b6ce JH |
117 | + |
118 | `strip` can be used as a synomym to `lstrip`. | |
9f613ddd JH |
119 | |
120 | objecttype:: | |
121 | The type of the object (`blob`, `tree`, `commit`, `tag`). | |
122 | ||
123 | objectsize:: | |
0b444cdb | 124 | The size of the object (the same as 'git cat-file -s' reports). |
9f613ddd JH |
125 | |
126 | objectname:: | |
127 | The object name (aka SHA-1). | |
67687fea | 128 | For a non-ambiguous abbreviation of the object name append `:short`. |
42d0eb05 KN |
129 | For an abbreviation of the object name with desired length append |
130 | `:short=<length>`, where the minimum length is MINIMUM_ABBREV. The | |
131 | length may be exceeded to ensure unique object names. | |
9f613ddd | 132 | |
8cae19d9 JK |
133 | upstream:: |
134 | The name of a local ref which can be considered ``upstream'' | |
1a34728e KN |
135 | from the displayed ref. Respects `:short`, `:lstrip` and |
136 | `:rstrip` in the same way as `refname` above. Additionally | |
137 | respects `:track` to show "[ahead N, behind M]" and | |
138 | `:trackshort` to show the terse version: ">" (ahead), "<" | |
139 | (behind), "<>" (ahead and behind), or "=" (in sync). `:track` | |
140 | also prints "[gone]" whenever unknown upstream ref is | |
141 | encountered. Append `:track,nobracket` to show tracking | |
142 | information without brackets (i.e "ahead N, behind M"). Has | |
143 | no effect if the ref does not have tracking information | |
144 | associated with it. All the options apart from `nobracket` | |
145 | are mutually exclusive, but if used together the last option | |
146 | is selected. | |
8cae19d9 | 147 | |
29bc8850 | 148 | push:: |
3ba308cb | 149 | The name of a local ref which represents the `@{push}` |
17938f17 | 150 | location for the displayed ref. Respects `:short`, `:lstrip`, |
1a34728e | 151 | `:rstrip`, `:track`, and `:trackshort` options as `upstream` |
3ba308cb KN |
152 | does. Produces an empty string if no `@{push}` ref is |
153 | configured. | |
29bc8850 | 154 | |
7a48b832 RR |
155 | HEAD:: |
156 | '*' if HEAD matches current ref (the checked out branch), ' ' | |
157 | otherwise. | |
158 | ||
fddb74c9 RR |
159 | color:: |
160 | Change output color. Followed by `:<colorname>`, where names | |
161 | are described in `color.branch.*`. | |
162 | ||
ce592082 KN |
163 | align:: |
164 | Left-, middle-, or right-align the content between | |
395fb8f9 KN |
165 | %(align:...) and %(end). The "align:" is followed by |
166 | `width=<width>` and `position=<position>` in any order | |
167 | separated by a comma, where the `<position>` is either left, | |
168 | right or middle, default being left and `<width>` is the total | |
169 | length of the content with alignment. For brevity, the | |
170 | "width=" and/or "position=" prefixes may be omitted, and bare | |
171 | <width> and <position> used instead. For instance, | |
172 | `%(align:<width>,<position>)`. If the contents length is more | |
173 | than the width then no alignment is performed. If used with | |
bcf9626a | 174 | `--quote` everything in between %(align:...) and %(end) is |
395fb8f9 KN |
175 | quoted, but if nested then only the topmost level performs |
176 | quoting. | |
ce592082 | 177 | |
c58492d4 KN |
178 | if:: |
179 | Used as %(if)...%(then)...%(end) or | |
180 | %(if)...%(then)...%(else)...%(end). If there is an atom with | |
181 | value or string literal after the %(if) then everything after | |
182 | the %(then) is printed, else if the %(else) atom is used, then | |
183 | everything after %(else) is printed. We ignore space when | |
184 | evaluating the string before %(then), this is useful when we | |
185 | use the %(HEAD) atom which prints either "*" or " " and we | |
186 | want to apply the 'if' condition only on the 'HEAD' ref. | |
4f3e3b37 KN |
187 | Append ":equals=<string>" or ":notequals=<string>" to compare |
188 | the value between the %(if:...) and %(then) atoms with the | |
189 | given string. | |
c58492d4 | 190 | |
a7984101 KN |
191 | symref:: |
192 | The ref which the given symbolic ref refers to. If not a | |
1a34728e KN |
193 | symbolic ref, nothing is printed. Respects the `:short`, |
194 | `:lstrip` and `:rstrip` options in the same way as `refname` | |
195 | above. | |
a7984101 | 196 | |
9f613ddd JH |
197 | In addition to the above, for commit and tag objects, the header |
198 | field names (`tree`, `parent`, `object`, `type`, and `tag`) can | |
199 | be used to specify the value in the header field. | |
200 | ||
e914ef0d EW |
201 | For commit and tag objects, the special `creatordate` and `creator` |
202 | fields will correspond to the appropriate date or name-email-date tuple | |
203 | from the `committer` or `tagger` fields depending on the object type. | |
204 | These are intended for working on a mix of annotated and lightweight tags. | |
205 | ||
9f613ddd JH |
206 | Fields that have name-email-date tuple as its value (`author`, |
207 | `committer`, and `tagger`) can be suffixed with `name`, `email`, | |
208 | and `date` to extract the named component. | |
209 | ||
e2b23972 | 210 | The complete message in a commit and tag object is `contents`. |
52ffe995 JW |
211 | Its first line is `contents:subject`, where subject is the concatenation |
212 | of all lines of the commit message up to the first blank line. The next | |
213 | line is 'contents:body', where body is all of the lines after the first | |
1bb38e5a KN |
214 | blank line. The optional GPG signature is `contents:signature`. The |
215 | first `N` lines of the message is obtained using `contents:lines=N`. | |
b1d31c89 JK |
216 | Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1] |
217 | are obtained as 'contents:trailers'. | |
9f613ddd | 218 | |
e914ef0d EW |
219 | For sorting purposes, fields with numeric values sort in numeric order |
220 | (`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`). | |
9f613ddd JH |
221 | All other fields are used to sort in their byte-value order. |
222 | ||
90c00408 KN |
223 | There is also an option to sort by versions, this can be done by using |
224 | the fieldname `version:refname` or its alias `v:refname`. | |
225 | ||
9f613ddd JH |
226 | In any case, a field name that refers to a field inapplicable to |
227 | the object referred by the ref does not cause an error. It | |
228 | returns an empty string instead. | |
229 | ||
d392e712 | 230 | As a special case for the date-type fields, you may specify a format for |
8f50d263 | 231 | the date by adding `:` followed by date format name (see the |
1cca17df | 232 | values the `--date` option to linkgit:git-rev-list[1] takes). |
d392e712 | 233 | |
c58492d4 KN |
234 | Some atoms like %(align) and %(if) always require a matching %(end). |
235 | We call them "opening atoms" and sometimes denote them as %($open). | |
236 | ||
237 | When a scripting language specific quoting is in effect, everything | |
238 | between a top-level opening atom and its matching %(end) is evaluated | |
239 | according to the semantics of the opening atom and only its result | |
240 | from the top-level is quoted. | |
241 | ||
9f613ddd JH |
242 | |
243 | EXAMPLES | |
244 | -------- | |
245 | ||
1729fa98 | 246 | An example directly producing formatted text. Show the most recent |
22817b40 | 247 | 3 tagged commits: |
9f613ddd JH |
248 | |
249 | ------------ | |
250 | #!/bin/sh | |
251 | ||
b1889c36 | 252 | git for-each-ref --count=3 --sort='-*authordate' \ |
9f613ddd JH |
253 | --format='From: %(*authorname) %(*authoremail) |
254 | Subject: %(*subject) | |
255 | Date: %(*authordate) | |
256 | Ref: %(*refname) | |
257 | ||
258 | %(*body) | |
259 | ' 'refs/tags' | |
260 | ------------ | |
261 | ||
1729fa98 AW |
262 | |
263 | A simple example showing the use of shell eval on the output, | |
22817b40 | 264 | demonstrating the use of --shell. List the prefixes of all heads: |
1729fa98 AW |
265 | ------------ |
266 | #!/bin/sh | |
267 | ||
b1889c36 | 268 | git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ |
1729fa98 AW |
269 | while read entry |
270 | do | |
271 | eval "$entry" | |
272 | echo `dirname $ref` | |
273 | done | |
274 | ------------ | |
275 | ||
276 | ||
277 | A bit more elaborate report on tags, demonstrating that the format | |
22817b40 | 278 | may be an entire script: |
9f613ddd JH |
279 | ------------ |
280 | #!/bin/sh | |
281 | ||
282 | fmt=' | |
283 | r=%(refname) | |
284 | t=%(*objecttype) | |
285 | T=${r#refs/tags/} | |
286 | ||
287 | o=%(*objectname) | |
288 | n=%(*authorname) | |
289 | e=%(*authoremail) | |
290 | s=%(*subject) | |
291 | d=%(*authordate) | |
292 | b=%(*body) | |
293 | ||
294 | kind=Tag | |
295 | if test "z$t" = z | |
296 | then | |
297 | # could be a lightweight tag | |
298 | t=%(objecttype) | |
299 | kind="Lightweight tag" | |
300 | o=%(objectname) | |
301 | n=%(authorname) | |
302 | e=%(authoremail) | |
303 | s=%(subject) | |
304 | d=%(authordate) | |
305 | b=%(body) | |
306 | fi | |
307 | echo "$kind $T points at a $t object $o" | |
308 | if test "z$t" = zcommit | |
309 | then | |
310 | echo "The commit was authored by $n $e | |
311 | at $d, and titled | |
312 | ||
313 | $s | |
314 | ||
315 | Its message reads as: | |
316 | " | |
317 | echo "$b" | sed -e "s/^/ /" | |
318 | echo | |
319 | fi | |
320 | ' | |
321 | ||
b1889c36 | 322 | eval=`git for-each-ref --shell --format="$fmt" \ |
9f613ddd JH |
323 | --sort='*objecttype' \ |
324 | --sort=-taggerdate \ | |
325 | refs/tags` | |
326 | eval "$eval" | |
327 | ------------ | |
621c39de | 328 | |
c58492d4 KN |
329 | |
330 | An example to show the usage of %(if)...%(then)...%(else)...%(end). | |
331 | This prefixes the current branch with a star. | |
332 | ||
333 | ------------ | |
334 | git for-each-ref --format="%(if)%(HEAD)%(then)* %(else) %(end)%(refname:short)" refs/heads/ | |
335 | ------------ | |
336 | ||
337 | ||
338 | An example to show the usage of %(if)...%(then)...%(end). | |
339 | This prints the authorname, if present. | |
340 | ||
341 | ------------ | |
342 | git for-each-ref --format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)" | |
343 | ------------ | |
344 | ||
f21e1c5d MH |
345 | SEE ALSO |
346 | -------- | |
347 | linkgit:git-show-ref[1] | |
348 | ||
621c39de AS |
349 | GIT |
350 | --- | |
351 | Part of the linkgit:git[1] suite |