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 upstream::
  89         The name of a local ref which can be considered ``upstream''
  90         from the displayed ref. Respects `:short` in the same way as
  91         `refname` above.
  92
  93 In addition to the above, for commit and tag objects, the header
  94 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
  95 be used to specify the value in the header field.
  96
  97 Fields that have name-email-date tuple as its value (`author`,
  98 `committer`, and `tagger`) can be suffixed with `name`, `email`,
  99 and `date` to extract the named component.
 100
 101 The first line of the message in a commit and tag object is
 102 `subject`, the remaining lines are `body`.  The whole message
 103 is `contents`.
 104
 105 For sorting purposes, fields with numeric values sort in numeric
 106 order (`objectsize`, `authordate`, `committerdate`, `taggerdate`).
 107 All other fields are used to sort in their byte-value order.
 108
 109 In any case, a field name that refers to a field inapplicable to
 110 the object referred by the ref does not cause an error.  It
 111 returns an empty string instead.
 112
 113 As a special case for the date-type fields, you may specify a format for
 114 the date by adding one of `:default`, `:relative`, `:short`, `:local`,
 115 `:iso8601` or `:rfc2822` to the end of the fieldname; e.g.
 116 `%(taggerdate:relative)`.
 117
 118
 119 EXAMPLES
 120 --------
 121
 122 An example directly producing formatted text.  Show the most recent
 123 3 tagged commits::
 124
 125 ------------
 126 #!/bin/sh
 127
 128 git for-each-ref --count=3 --sort='-*authordate' \
 129 --format='From: %(*authorname) %(*authoremail)
 130 Subject: %(*subject)
 131 Date: %(*authordate)
 132 Ref: %(*refname)
 133
 134 %(*body)
 135 ' 'refs/tags'
 136 ------------
 137
 138
 139 A simple example showing the use of shell eval on the output,
 140 demonstrating the use of --shell.  List the prefixes of all heads::
 141 ------------
 142 #!/bin/sh
 143
 144 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
 145 while read entry
 146 do
 147         eval "$entry"
 148         echo `dirname $ref`
 149 done
 150 ------------
 151
 152
 153 A bit more elaborate report on tags, demonstrating that the format
 154 may be an entire script::
 155 ------------
 156 #!/bin/sh
 157
 158 fmt='
 159         r=%(refname)
 160         t=%(*objecttype)
 161         T=${r#refs/tags/}
 162
 163         o=%(*objectname)
 164         n=%(*authorname)
 165         e=%(*authoremail)
 166         s=%(*subject)
 167         d=%(*authordate)
 168         b=%(*body)
 169
 170         kind=Tag
 171         if test "z$t" = z
 172         then
 173                 # could be a lightweight tag
 174                 t=%(objecttype)
 175                 kind="Lightweight tag"
 176                 o=%(objectname)
 177                 n=%(authorname)
 178                 e=%(authoremail)
 179                 s=%(subject)
 180                 d=%(authordate)
 181                 b=%(body)
 182         fi
 183         echo "$kind $T points at a $t object $o"
 184         if test "z$t" = zcommit
 185         then
 186                 echo "The commit was authored by $n $e
 187 at $d, and titled
 188
 189     $s
 190
 191 Its message reads as:
 192 "
 193                 echo "$b" | sed -e "s/^/    /"
 194                 echo
 195         fi
 196 '
 197
 198 eval=`git for-each-ref --shell --format="$fmt" \
 199         --sort='*objecttype' \
 200         --sort=-taggerdate \
 201         refs/tags`
 202 eval "$eval"
 203 ------------