NAME

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

SYNOPSIS

git for-each-ref [--count=<count>] [--shell|--perl|--python|--tcl]


                   [(--sort=<key>)...] [--format=<format>] [<pattern>...]


                   [--points-at=<object>]


                   (--merged[=<object>] | --no-merged[=<object>])


                   [--contains[=<object>]] [--no-contains[=<object>]]

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

<pattern>...

--count=<count>

--sort=<key>

--format=<format>

--color[=<when>]

--shell, --perl, --python, --tcl

--points-at=<object>

--merged[=<object>]

--no-merged[=<object>]

--contains[=<object>]

--no-contains[=<object>]

--ignore-case

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

objecttype

objectsize

objectname

upstream

push

HEAD

color

align

if

symref

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.

For commit and tag objects, the special creatordate and creator fields will correspond to the appropriate date or name-email-date tuple from the committer or tagger fields depending on the object type. These are intended for working on a mix of annotated and lightweight tags.

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. The optional GPG signature is contents:signature. The first N lines of the message is obtained using contents:lines=N. Additionally, the trailers as interpreted by git-interpret-trailers(1) are obtained as trailers (or by using the historical alias contents:trailers). Non-trailer lines from the trailer block can be omitted with trailers:only. Whitespace-continuations can be removed from trailers so that each trailer appears on a line by itself with its full content with trailers:unfold. Both can be used together as trailers:unfold,only.

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

There is also an option to sort by versions, this can be done by using the fieldname version:refname or its alias v:refname.

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 : followed by date format name (see the values the --date option to git-rev-list(1) takes).

Some atoms like %(align) and %(if) always require a matching %(end). We call them "opening atoms" and sometimes denote them as %($open).

When a scripting language specific quoting is in effect, everything between a top-level opening atom and its matching %(end) is evaluated according to the semantics of the opening atom and only its result from the top-level is quoted.

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"

An example to show the usage of %(if)...%(then)...%(else)...%(end). This prefixes the current branch with a star.

git for-each-ref --format="%(if)%(HEAD)%(then)* %(else)  %(end)%(refname:short)" refs/heads/

An example to show the usage of %(if)...%(then)...%(end). This prints the authorname, if present.

git for-each-ref --format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)"

SEE ALSO

git-show-ref(1)

GIT

Part of the git(1) suite