Documentation/git-for-each-ref.txt

   1 git-for-each-ref(1)
   2 ===================
   3
   4 NAME
   5 ----
   6 git-for-each-ref - Output information on each ref
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
  12                    [--sort=<key>]\* [--format=<format>] [<pattern>...]
  13
  14 DESCRIPTION
  15 -----------
  16
  17 Iterate over all refs that match `<pattern>` and show them
  18 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 OPTIONS
  25 -------
  26 <count>::
  27         By default the command shows all refs that match
  28         `<pattern>`.  This option makes it stop after showing
  29         that many refs.
  30
  31 <key>::
  32         A field name to sort on.  Prefix `-` to sort in
  33         descending order of the value.  When unspecified,
  34         `refname` is used.  You may use the --sort=<key> option
  35         multiple times, in which case the last key becomes the primary
  36         key.
  37
  38 <format>::
  39         A string that interpolates `%(fieldname)` from the
  40         object pointed at by a ref being shown.  If `fieldname`
  41         is prefixed with an asterisk (`*`) and the ref points
  42         at a tag object, the value for the field in the object
  43         tag refers is used.  When unspecified, defaults to
  44         `%(objectname) SPC %(objecttype) TAB %(refname)`.
  45         It also interpolates `%%` to `%`, and `%xx` where `xx`
  46         are hex digits interpolates to character with hex code
  47         `xx`; for example `%00` interpolates to `\0` (NUL),
  48         `%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         literally, in the latter case matching completely or from the
  54         beginning up to a slash.
  55
  56 --shell::
  57 --perl::
  58 --python::
  59 --tcl::
  60         If given, strings that substitute `%(fieldname)`
  61         placeholders are quoted as string literals suitable for
  62         the specified host language.  This is meant to produce
  63         a scriptlet that can directly be `eval`ed.
  64
  65
  66 FIELD NAMES
  67 -----------
  68
  69 Various values from structured fields in referenced objects can
  70 be used to interpolate into the resulting output, or as sort
  71 keys.
  72
  73 For all objects, the following names can be used:
  74
  75 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 objecttype::
  80         The type of the object (`blob`, `tree`, `commit`, `tag`).
  81
  82 objectsize::
  83         The size of the object (the same as 'git-cat-file -s' reports).
  84
  85 objectname::
  86         The object name (aka SHA-1).
  87
  88 In addition to the above, for commit and tag objects, the header
  89 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
  90 be used to specify the value in the header field.
  91
  92 Fields that have name-email-date tuple as its value (`author`,
  93 `committer`, and `tagger`) can be suffixed with `name`, `email`,
  94 and `date` to extract the named component.
  95
  96 The first line of the message in a commit and tag object is
  97 `subject`, the remaining lines are `body`.  The whole message
  98 is `contents`.
  99
 100 For sorting purposes, fields with numeric values sort in numeric
 101 order (`objectsize`, `authordate`, `committerdate`, `taggerdate`).
 102 All other fields are used to sort in their byte-value order.
 103
 104 In any case, a field name that refers to a field inapplicable to
 105 the object referred by the ref does not cause an error.  It
 106 returns an empty string instead.
 107
 108 As a special case for the date-type fields, you may specify a format for
 109 the date by adding one of `:default`, `:relative`, `:short`, `:local`,
 110 `:iso8601` or `:rfc2822` to the end of the fieldname; e.g.
 111 `%(taggerdate:relative)`.
 112
 113
 114 EXAMPLES
 115 --------
 116
 117 An example directly producing formatted text.  Show the most recent
 118 3 tagged commits::
 119
 120 ------------
 121 #!/bin/sh
 122
 123 git for-each-ref --count=3 --sort='-*authordate' \
 124 --format='From: %(*authorname) %(*authoremail)
 125 Subject: %(*subject)
 126 Date: %(*authordate)
 127 Ref: %(*refname)
 128
 129 %(*body)
 130 ' 'refs/tags'
 131 ------------
 132
 133
 134 A simple example showing the use of shell eval on the output,
 135 demonstrating the use of --shell.  List the prefixes of all heads::
 136 ------------
 137 #!/bin/sh
 138
 139 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
 140 while read entry
 141 do
 142         eval "$entry"
 143         echo `dirname $ref`
 144 done
 145 ------------
 146
 147
 148 A bit more elaborate report on tags, demonstrating that the format
 149 may be an entire script::
 150 ------------
 151 #!/bin/sh
 152
 153 fmt='
 154         r=%(refname)
 155         t=%(*objecttype)
 156         T=${r#refs/tags/}
 157
 158         o=%(*objectname)
 159         n=%(*authorname)
 160         e=%(*authoremail)
 161         s=%(*subject)
 162         d=%(*authordate)
 163         b=%(*body)
 164
 165         kind=Tag
 166         if test "z$t" = z
 167         then
 168                 # could be a lightweight tag
 169                 t=%(objecttype)
 170                 kind="Lightweight tag"
 171                 o=%(objectname)
 172                 n=%(authorname)
 173                 e=%(authoremail)
 174                 s=%(subject)
 175                 d=%(authordate)
 176                 b=%(body)
 177         fi
 178         echo "$kind $T points at a $t object $o"
 179         if test "z$t" = zcommit
 180         then
 181                 echo "The commit was authored by $n $e
 182 at $d, and titled
 183
 184     $s
 185
 186 Its message reads as:
 187 "
 188                 echo "$b" | sed -e "s/^/    /"
 189                 echo
 190         fi
 191 '
 192
 193 eval=`git for-each-ref --shell --format="$fmt" \
 194         --sort='*objecttype' \
 195         --sort=-taggerdate \
 196         refs/tags`
 197 eval "$eval"
 198 ------------