summaryrefslogtreecommitdiff
path: root/Documentation/git-for-each-ref.txt
blob: 6649f795e8714d9f084a5f4db18bf3a1d405d46a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
git-for-each-ref(1)
===================
 
NAME
----
git-for-each-ref - Output information on each ref
 
SYNOPSIS
--------
'git-for-each-ref' [--count=<count>]* [--shell|--perl|--python] [--sort=<key>]* [--format=<format>] [<pattern>]
 
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>`s.  If `<max>` is given, stop after
showing that many refs.  The interporated values in `<format>`
can optionally be quoted as string literals in the specified
host language.
 
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,
	`refname` is used.  More than one sort keys can be
	given.
 
<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
	`%(refname)`.
 
<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.
 
--shell, --perl, --python::
	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::
	The name of the ref (the part after $GIT_DIR/refs/).
 
objecttype::
	The type of the object (`blob`, `tree`, `commit`, `tag`).
 
objectsize::
	The size of the object (the same as `git-cat-file -s` reports).
 
objectname::
	The object name (aka SHA-1).
 
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.
 
The first line of the message in a commit and tag object is
`subject`, the remaining lines are `body`.  The whole message
is `contents`.
 
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.
 
 
EXAMPLES
--------
 
Show the most recent 3 tagged commits::
 
------------
#!/bin/sh
 
git-for-each-ref --count=3 --sort='-*authordate' \
--format='From: %(*authorname) %(*authoremail)
Subject: %(*subject)
Date: %(*authordate)
Ref: %(*refname)
 
%(*body)
' 'refs/tags'
------------
 
A bit more elaborate report on tags::
------------
#!/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
'
 
eval=`git-for-each-ref -s --format="$fmt" \
	--sort='*objecttype' \
	--sort=-taggerdate \
	refs/tags`
eval "$eval"
------------