git-for-each-ref.txt 5.72 KB
Newer Older
1 2 3 4 5 6 7 8 9
git-for-each-ref(1)
===================

NAME
----
git-for-each-ref - Output information on each ref

SYNOPSIS
--------
10
[verse]
11
'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
12
		   [(--sort=<key>)...] [--format=<format>] [<pattern>...]
13 14 15 16 17 18

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

Iterate over all refs that match `<pattern>` and show them
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.
23 24 25 26 27 28 29 30 31 32 33

OPTIONS
-------
<count>::
	By default the command shows all refs that match
	`<pattern>`.  This option makes it stop after showing
	that many refs.

<key>::
	A field name to sort on.  Prefix `-` to sort in
	descending order of the value.  When unspecified,
34 35 36
	`refname` is used.  You may use the --sort=<key> option
	multiple times, in which case the last key becomes the primary
	key.
37 38 39 40 41 42 43

<format>::
	A string that interpolates `%(fieldname)` from the
	object pointed at by a ref being shown.  If `fieldname`
	is prefixed with an asterisk (`*`) and the ref points
	at a tag object, the value for the field in the object
	tag refers is used.  When unspecified, defaults to
44 45 46 47 48
	`%(objectname) SPC %(objecttype) TAB %(refname)`.
	It also interpolates `%%` to `%`, and `%xx` where `xx`
	are hex digits interpolates to character with hex code
	`xx`; for example `%00` interpolates to `\0` (NUL),
	`%09` to `\t` (TAB) and `%0a` to `\n` (LF).
49

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 54
	literally, in the latter case matching completely or from the
	beginning up to a slash.
55

56 57 58 59
--shell::
--perl::
--python::
--tcl::
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
	If given, strings that substitute `%(fieldname)`
	placeholders are quoted as string literals suitable for
	the specified host language.  This is meant to produce
	a scriptlet that can directly be `eval`ed.


FIELD NAMES
-----------

Various values from structured fields in referenced objects can
be used to interpolate into the resulting output, or as sort
keys.

For all objects, the following names can be used:

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 79
	The option core.warnAmbiguousRefs is used to select the strict
	abbreviation mode.
80 81 82 83 84

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

objectsize::
85
	The size of the object (the same as 'git cat-file -s' reports).
86 87 88

objectname::
	The object name (aka SHA-1).
89
	For a non-ambiguous abbreviation of the object name append `:short`.
90

91 92 93 94 95
upstream::
	The name of a local ref which can be considered ``upstream''
	from the displayed ref. Respects `:short` in the same way as
	`refname` above.

96 97 98 99 100 101 102 103
In addition to the above, for commit and tag objects, the header
field names (`tree`, `parent`, `object`, `type`, and `tag`) can
be used to specify the value in the header field.

Fields that have name-email-date tuple as its value (`author`,
`committer`, and `tagger`) can be suffixed with `name`, `email`,
and `date` to extract the named component.

104
The complete message in a commit and tag object is `contents`.
105 106 107 108
Its first line is `contents:subject`, where subject is the concatenation
of all lines of the commit message up to the first blank line.  The next
line is 'contents:body', where body is all of the lines after the first
blank line.  Finally, the optional GPG signature is `contents:signature`.
109 110 111 112 113 114 115 116 117

For sorting purposes, fields with numeric values sort in numeric
order (`objectsize`, `authordate`, `committerdate`, `taggerdate`).
All other fields are used to sort in their byte-value order.

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.

118 119
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`,
120
`:iso8601`, `:rfc2822` or `:raw` to the end of the fieldname; e.g.
121 122
`%(taggerdate:relative)`.

123 124 125 126

EXAMPLES
--------

127
An example directly producing formatted text.  Show the most recent
128
3 tagged commits:
129 130 131 132

------------
#!/bin/sh

133
git for-each-ref --count=3 --sort='-*authordate' \
134 135 136 137 138 139 140 141 142
--format='From: %(*authorname) %(*authoremail)
Subject: %(*subject)
Date: %(*authordate)
Ref: %(*refname)

%(*body)
' 'refs/tags'
------------

143 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 148
------------
#!/bin/sh

149
git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
150 151 152 153 154 155 156 157 158
while read entry
do
	eval "$entry"
	echo `dirname $ref`
done
------------


A bit more elaborate report on tags, demonstrating that the format
159
may be an entire script:
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
------------
#!/bin/sh

fmt='
	r=%(refname)
	t=%(*objecttype)
	T=${r#refs/tags/}

	o=%(*objectname)
	n=%(*authorname)
	e=%(*authoremail)
	s=%(*subject)
	d=%(*authordate)
	b=%(*body)

	kind=Tag
	if test "z$t" = z
	then
		# could be a lightweight tag
		t=%(objecttype)
		kind="Lightweight tag"
		o=%(objectname)
		n=%(authorname)
		e=%(authoremail)
		s=%(subject)
		d=%(authordate)
		b=%(body)
	fi
	echo "$kind $T points at a $t object $o"
	if test "z$t" = zcommit
	then
		echo "The commit was authored by $n $e
at $d, and titled

    $s

Its message reads as:
"
		echo "$b" | sed -e "s/^/    /"
		echo
	fi
'

203
eval=`git for-each-ref --shell --format="$fmt" \
204 205 206 207 208
	--sort='*objecttype' \
	--sort=-taggerdate \
	refs/tags`
eval "$eval"
------------
209 210 211 212 213 214 215 216 217 218 219 220

Author
------
Written by Junio C Hamano <gitster@pobox.com>.

Documentation
-------------
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.

GIT
---
Part of the linkgit:git[1] suite