git.oblomov.eu Git - git/blob - 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         The option core.warnAmbiguousRefs is used to select the strict
  79         abbreviation mode.
  80
  81 objecttype::
  82         The type of the object (`blob`, `tree`, `commit`, `tag`).
  83
  84 objectsize::
  85         The size of the object (the same as 'git cat-file -s' reports).
  86
  87 objectname::
  88         The object name (aka SHA-1).
  89         For a non-ambiguous abbreviation of the object name append `:short`.
  90
  91 upstream::
  92         The name of a local ref which can be considered ``upstream''
  93         from the displayed ref. Respects `:short` in the same way as
  94         `refname` above.  Additionally respects `:track` to show
  95         "[ahead N, behind M]" and `:trackshort` to show the terse
  96         version: ">" (ahead), "<" (behind), "<>" (ahead and behind),
  97         or "=" (in sync).  Has no effect if the ref does not have
  98         tracking information associated with it.
  99
 100 HEAD::
 101         '*' if HEAD matches current ref (the checked out branch), ' '
 102         otherwise.
 103
 104 color::
 105         Change output color.  Followed by `:<colorname>`, where names
 106         are described in `color.branch.*`.
 107
 108 In addition to the above, for commit and tag objects, the header
 109 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
 110 be used to specify the value in the header field.
 111
 112 For commit and tag objects, the special `creatordate` and `creator`
 113 fields will correspond to the appropriate date or name-email-date tuple
 114 from the `committer` or `tagger` fields depending on the object type.
 115 These are intended for working on a mix of annotated and lightweight tags.
 116
 117 Fields that have name-email-date tuple as its value (`author`,
 118 `committer`, and `tagger`) can be suffixed with `name`, `email`,
 119 and `date` to extract the named component.
 120
 121 The complete message in a commit and tag object is `contents`.
 122 Its first line is `contents:subject`, where subject is the concatenation
 123 of all lines of the commit message up to the first blank line.  The next
 124 line is 'contents:body', where body is all of the lines after the first
 125 blank line.  Finally, the optional GPG signature is `contents:signature`.
 126
 127 For sorting purposes, fields with numeric values sort in numeric order
 128 (`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`).
 129 All other fields are used to sort in their byte-value order.
 130
 131 In any case, a field name that refers to a field inapplicable to
 132 the object referred by the ref does not cause an error.  It
 133 returns an empty string instead.
 134
 135 As a special case for the date-type fields, you may specify a format for
 136 the date by adding one of `:default`, `:relative`, `:short`, `:local`,
 137 `:iso8601`, `:rfc2822` or `:raw` to the end of the fieldname; e.g.
 138 `%(taggerdate:relative)`.
 139
 140
 141 EXAMPLES
 142 --------
 143
 144 An example directly producing formatted text.  Show the most recent
 145 3 tagged commits:
 146
 147 ------------
 148 #!/bin/sh
 149
 150 git for-each-ref --count=3 --sort='-*authordate' \
 151 --format='From: %(*authorname) %(*authoremail)
 152 Subject: %(*subject)
 153 Date: %(*authordate)
 154 Ref: %(*refname)
 155
 156 %(*body)
 157 ' 'refs/tags'
 158 ------------
 159
 160
 161 A simple example showing the use of shell eval on the output,
 162 demonstrating the use of --shell.  List the prefixes of all heads:
 163 ------------
 164 #!/bin/sh
 165
 166 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
 167 while read entry
 168 do
 169         eval "$entry"
 170         echo `dirname $ref`
 171 done
 172 ------------
 173
 174
 175 A bit more elaborate report on tags, demonstrating that the format
 176 may be an entire script:
 177 ------------
 178 #!/bin/sh
 179
 180 fmt='
 181         r=%(refname)
 182         t=%(*objecttype)
 183         T=${r#refs/tags/}
 184
 185         o=%(*objectname)
 186         n=%(*authorname)
 187         e=%(*authoremail)
 188         s=%(*subject)
 189         d=%(*authordate)
 190         b=%(*body)
 191
 192         kind=Tag
 193         if test "z$t" = z
 194         then
 195                 # could be a lightweight tag
 196                 t=%(objecttype)
 197                 kind="Lightweight tag"
 198                 o=%(objectname)
 199                 n=%(authorname)
 200                 e=%(authoremail)
 201                 s=%(subject)
 202                 d=%(authordate)
 203                 b=%(body)
 204         fi
 205         echo "$kind $T points at a $t object $o"
 206         if test "z$t" = zcommit
 207         then
 208                 echo "The commit was authored by $n $e
 209 at $d, and titled
 210
 211     $s
 212
 213 Its message reads as:
 214 "
 215                 echo "$b" | sed -e "s/^/    /"
 216                 echo
 217         fi
 218 '
 219
 220 eval=`git for-each-ref --shell --format="$fmt" \
 221         --sort='*objecttype' \
 222         --sort=-taggerdate \
 223         refs/tags`
 224 eval "$eval"
 225 ------------
 226
 227 SEE ALSO
 228 --------
 229 linkgit:git-show-ref[1]
 230
 231 GIT
 232 ---
 233 Part of the linkgit:git[1] suite