table of contents
other versions
- wheezy 1:1.7.10.4-1+wheezy3
- wheezy-backports 1:1.9.1-1~bpo70+2
- jessie 1:2.1.4-2.1+deb8u2
- jessie-backports 1:2.11.0-3~bpo8+1
- testing 1:2.11.0-3
- unstable 1:2.11.0-4
- experimental 1:2.13.1+next.20170610-1
GIT-FOR-EACH-REF(1) | Git Manual | GIT-FOR-EACH-REF(1) |
NAME¶
git-for-each-ref - Output information on each refSYNOPSIS¶
git for-each-ref [--count=<count>] [--shell|--perl|--python|--tcl] [(--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>. 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).
<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.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.
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'
#!/bin/sh git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ while read entry do eval "$entry" echo `dirname $ref` done
#!/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[1]>.DOCUMENTATION¶
Documentation by Junio C Hamano and the git-list < git@vger.kernel.org[2]>.GIT¶
Part of the git(1) suiteNOTES¶
- 1.
- gitster@pobox.com
mailto:gitster@pobox.com
- 2.
- git@vger.kernel.org
mailto:git@vger.kernel.org
03/19/2016 | Git 1.7.10.4 |