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>]\*
  12                    [--shell|--perl|--python|--tcl]
  13                    [--sort=<key>]\* [--format=<format>] [<pattern>]
  14
  15 DESCRIPTION
  16 -----------
  17
  18 Iterate over all refs that match `<pattern>` and show them
  19 according to the given `<format>`, after sorting them according
  20 to the given set of `<key>`.  If `<max>` is given, stop after
  21 showing that many refs.  The interpolated values in `<format>`
  22 can optionally be quoted as string literals in the specified
  23 host language allowing their direct evaluation in that language.
  24
  25 OPTIONS
  26 -------
  27 <count>::
  28         By default the command shows all refs that match
  29         `<pattern>`.  This option makes it stop after showing
  30         that many refs.
  31
  32 <key>::
  33         A field name to sort on.  Prefix `-` to sort in
  34         descending order of the value.  When unspecified,
  35         `refname` is used.  More than one sort keys can be
  36         given.
  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 given, the name of the ref is matched against this
  52         using fnmatch(3).  Refs that do not match the pattern
  53         are not shown.
  54
  55 --shell, --perl, --python, --tcl::
  56         If given, strings that substitute `%(fieldname)`
  57         placeholders are quoted as string literals suitable for
  58         the specified host language.  This is meant to produce
  59         a scriptlet that can directly be `eval`ed.
  60
  61
  62 FIELD NAMES
  63 -----------
  64
  65 Various values from structured fields in referenced objects can
  66 be used to interpolate into the resulting output, or as sort
  67 keys.
  68
  69 For all objects, the following names can be used:
  70
  71 refname::
  72         The name of the ref (the part after $GIT_DIR/).
  73
  74 objecttype::
  75         The type of the object (`blob`, `tree`, `commit`, `tag`).
  76
  77 objectsize::
  78         The size of the object (the same as `git-cat-file -s` reports).
  79
  80 objectname::
  81         The object name (aka SHA-1).
  82
  83 In addition to the above, for commit and tag objects, the header
  84 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
  85 be used to specify the value in the header field.
  86
  87 Fields that have name-email-date tuple as its value (`author`,
  88 `committer`, and `tagger`) can be suffixed with `name`, `email`,
  89 and `date` to extract the named component.
  90
  91 The first line of the message in a commit and tag object is
  92 `subject`, the remaining lines are `body`.  The whole message
  93 is `contents`.
  94
  95 For sorting purposes, fields with numeric values sort in numeric
  96 order (`objectsize`, `authordate`, `committerdate`, `taggerdate`).
  97 All other fields are used to sort in their byte-value order.
  98
  99 In any case, a field name that refers to a field inapplicable to
 100 the object referred by the ref does not cause an error.  It
 101 returns an empty string instead.
 102
 103
 104 EXAMPLES
 105 --------
 106
 107 An example directly producing formatted text.  Show the most recent
 108 3 tagged commits::
 109
 110 ------------
 111 #!/bin/sh
 112
 113 git-for-each-ref --count=3 --sort='-*authordate' \
 114 --format='From: %(*authorname) %(*authoremail)
 115 Subject: %(*subject)
 116 Date: %(*authordate)
 117 Ref: %(*refname)
 118
 119 %(*body)
 120 ' 'refs/tags'
 121 ------------
 122
 123
 124 A simple example showing the use of shell eval on the output,
 125 demonstrating the use of --shell.  List the prefixes of all heads::
 126 ------------
 127 #!/bin/sh
 128
 129 git-for-each-ref --shell --format="ref=%(refname)" refs/heads | \
 130 while read entry
 131 do
 132         eval "$entry"
 133         echo `dirname $ref`
 134 done
 135 ------------
 136
 137
 138 A bit more elaborate report on tags, demonstrating that the format
 139 may be an entire script::
 140 ------------
 141 #!/bin/sh
 142
 143 fmt='
 144         r=%(refname)
 145         t=%(*objecttype)
 146         T=${r#refs/tags/}
 147
 148         o=%(*objectname)
 149         n=%(*authorname)
 150         e=%(*authoremail)
 151         s=%(*subject)
 152         d=%(*authordate)
 153         b=%(*body)
 154
 155         kind=Tag
 156         if test "z$t" = z
 157         then
 158                 # could be a lightweight tag
 159                 t=%(objecttype)
 160                 kind="Lightweight tag"
 161                 o=%(objectname)
 162                 n=%(authorname)
 163                 e=%(authoremail)
 164                 s=%(subject)
 165                 d=%(authordate)
 166                 b=%(body)
 167         fi
 168         echo "$kind $T points at a $t object $o"
 169         if test "z$t" = zcommit
 170         then
 171                 echo "The commit was authored by $n $e
 172 at $d, and titled
 173
 174     $s
 175
 176 Its message reads as:
 177 "
 178                 echo "$b" | sed -e "s/^/    /"
 179                 echo
 180         fi
 181 '
 182
 183 eval=`git-for-each-ref --shell --format="$fmt" \
 184         --sort='*objecttype' \
 185         --sort=-taggerdate \
 186         refs/tags`
 187 eval "$eval"
 188 ------------