git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
ef39f2acddfd35e35b4e8c637e1fca812177e718 blob 7278 bytes (raw)

  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
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
git-for-each-ref(1)
===================

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

SYNOPSIS
--------
[verse]
'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
		   [(--sort=<key>)...] [--format=<format>|--pretty=<pretty>]
		   [<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>`.  If `<count>` is given, stop after
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.

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.  You may use the --sort=<key> option
	multiple times, in which case the last key becomes the primary
	key.

<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
	`%(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).
+
Placeholders `%<(*)` and `%>(*)` work like `%<(<N>)` and `%>(<N>)`
respectively, except that the width of the next placeholder is
calculated.

<pretty>::
	A format string with supporting placeholders described in the
	"PRETTY FORMATS" section in linkgit:git-log[1].  Additionally
	supports placeholders from `<format>`
	(i.e. `%[*](fieldname)`).
+
Caveats:

0. No built-in formats from PRETTY FORMATS (like oneline, short) are
   available.

1. Many of the placeholders in "PRETTY FORMATS" are designed to work
   specifically on commit objects: when non-commit objects are
   supplied, those placeholders won't work (i.e. they will be emitted
   literally).

2. Does not interpolate `%ab` (where `ab` are hex digits) with the
   corresponding hex code.  To print a byte from a hex code, use
   `%xab` (from pretty-formats) instead.

3. Only the placeholders inherited from `<format>` will respect
   quoting settings.

3. Only the placeholders inherited from `<format>` will work with the
   alignment placeholders `%<(*)` and '%>(*)`.

<pattern>...::
	If one or more patterns are given, only refs are shown that
	match against at least one pattern, either using fnmatch(3) or
	literally, in the latter case matching completely or from the
	beginning up to a slash.

--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
	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/).
	For a non-ambiguous short name of the ref append `:short`.
	The option core.warnAmbiguousRefs is used to select the strict
	abbreviation mode.

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).
	For a non-ambiguous abbreviation of the object name append `:short`.

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.  Additionally respects `:track` to show
	"[ahead N, behind M]" and `:trackshort` to show the terse
	version (like the prompt) ">", "<", "<>", or "=".  Has no
	effect if the ref does not have tracking information
	associated with it.

HEAD::
	Useful to indicate the currently checked out branch.  Is '*'
	if HEAD points to the current ref, and ' ' otherwise.

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 complete message in a commit and tag object is `contents`.
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`.

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.

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


EXAMPLES
--------

An example directly producing formatted text.  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 simple example showing the use of shell eval on the output,
demonstrating the use of --shell.  List the prefixes of all heads:
------------
#!/bin/sh

git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
while read entry
do
	eval "$entry"
	echo `dirname $ref`
done
------------


A bit more elaborate report on tags, demonstrating that the format
may be an entire script:
------------
#!/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 --shell --format="$fmt" \
	--sort='*objecttype' \
	--sort=-taggerdate \
	refs/tags`
eval "$eval"
------------

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
debug log:

solving ef39f2a ...
found ef39f2a in https://public-inbox.org/git/1373365946-9230-16-git-send-email-artagnon@gmail.com/ ||
	https://public-inbox.org/git/1370800474-8940-16-git-send-email-artagnon@gmail.com/
found d666ebd in https://public-inbox.org/git/1373365946-9230-13-git-send-email-artagnon@gmail.com/ ||
	https://public-inbox.org/git/1370800474-8940-13-git-send-email-artagnon@gmail.com/
found 8d982e3 in https://public-inbox.org/git/1373365946-9230-12-git-send-email-artagnon@gmail.com/ ||
	https://public-inbox.org/git/1370800474-8940-12-git-send-email-artagnon@gmail.com/
found 8cbc08c in https://public-inbox.org/git/1373365946-9230-11-git-send-email-artagnon@gmail.com/ ||
	https://public-inbox.org/git/1370800474-8940-11-git-send-email-artagnon@gmail.com/
found d8ad758 in https://public-inbox.org/git/1373365946-9230-9-git-send-email-artagnon@gmail.com/ ||
	https://public-inbox.org/git/1370800474-8940-9-git-send-email-artagnon@gmail.com/
found f2e08d1 in git.git.git
preparing index
index prepared:
100644 f2e08d11c19cf127c5f7d484b0c3d66fc475d547	Documentation/git-for-each-ref.txt

applying [1/10] https://public-inbox.org/git/1373365946-9230-9-git-send-email-artagnon@gmail.com/
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index f2e08d1..d8ad758 100644

Checking patch Documentation/git-for-each-ref.txt...
Applied patch Documentation/git-for-each-ref.txt cleanly.

skipping https://public-inbox.org/git/1370800474-8940-9-git-send-email-artagnon@gmail.com/ for d8ad758
index at:
100644 d8ad7587a2fe7853958b7fc350dd86eedce938ca	Documentation/git-for-each-ref.txt

applying [2/10] https://public-inbox.org/git/1373365946-9230-11-git-send-email-artagnon@gmail.com/
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index d8ad758..8cbc08c 100644

Checking patch Documentation/git-for-each-ref.txt...
Applied patch Documentation/git-for-each-ref.txt cleanly.

skipping https://public-inbox.org/git/1370800474-8940-11-git-send-email-artagnon@gmail.com/ for 8cbc08c
index at:
100644 8cbc08cb28c920a96d6881ed1a34181129c5ed14	Documentation/git-for-each-ref.txt

applying [3/10] https://public-inbox.org/git/1373365946-9230-12-git-send-email-artagnon@gmail.com/
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 8cbc08c..8d982e3 100644

Checking patch Documentation/git-for-each-ref.txt...
Applied patch Documentation/git-for-each-ref.txt cleanly.

skipping https://public-inbox.org/git/1370800474-8940-12-git-send-email-artagnon@gmail.com/ for 8d982e3
index at:
100644 8d982e36a58519542992b536ac987b9c9992148a	Documentation/git-for-each-ref.txt

applying [4/10] https://public-inbox.org/git/1373365946-9230-13-git-send-email-artagnon@gmail.com/
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 8d982e3..d666ebd 100644

Checking patch Documentation/git-for-each-ref.txt...
Applied patch Documentation/git-for-each-ref.txt cleanly.

skipping https://public-inbox.org/git/1370800474-8940-13-git-send-email-artagnon@gmail.com/ for d666ebd
index at:
100644 d666ebd25e9ec874e90cd92ac48459205ad0fbeb	Documentation/git-for-each-ref.txt

applying [5/10] https://public-inbox.org/git/1373365946-9230-16-git-send-email-artagnon@gmail.com/
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index d666ebd..ef39f2a 100644

Checking patch Documentation/git-for-each-ref.txt...
Applied patch Documentation/git-for-each-ref.txt cleanly.

skipping https://public-inbox.org/git/1370800474-8940-16-git-send-email-artagnon@gmail.com/ for ef39f2a
index at:
100644 ef39f2acddfd35e35b4e8c637e1fca812177e718	Documentation/git-for-each-ref.txt

Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).