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                    [--points-at <object>] [(--merged | --no-merged) [<object>]]
  14                    [--contains [<object>]]
  15
  16 DESCRIPTION
  17 -----------
  18
  19 Iterate over all refs that match `<pattern>` and show them
  20 according to the given `<format>`, after sorting them according
  21 to the given set of `<key>`.  If `<count>` is given, stop after
  22 showing that many refs.  The interpolated values in `<format>`
  23 can optionally be quoted as string literals in the specified
  24 host language allowing their direct evaluation in that language.
  25
  26 OPTIONS
  27 -------
  28 <count>::
  29         By default the command shows all refs that match
  30         `<pattern>`.  This option makes it stop after showing
  31         that many refs.
  32
  33 <key>::
  34         A field name to sort on.  Prefix `-` to sort in
  35         descending order of the value.  When unspecified,
  36         `refname` is used.  You may use the --sort=<key> option
  37         multiple times, in which case the last key becomes the primary
  38         key.
  39
  40 <format>::
  41         A string that interpolates `%(fieldname)` from the
  42         object pointed at by a ref being shown.  If `fieldname`
  43         is prefixed with an asterisk (`*`) and the ref points
  44         at a tag object, the value for the field in the object
  45         tag refers is used.  When unspecified, defaults to
  46         `%(objectname) SPC %(objecttype) TAB %(refname)`.
  47         It also interpolates `%%` to `%`, and `%xx` where `xx`
  48         are hex digits interpolates to character with hex code
  49         `xx`; for example `%00` interpolates to `\0` (NUL),
  50         `%09` to `\t` (TAB) and `%0a` to `\n` (LF).
  51
  52 <pattern>...::
  53         If one or more patterns are given, only refs are shown that
  54         match against at least one pattern, either using fnmatch(3) or
  55         literally, in the latter case matching completely or from the
  56         beginning up to a slash.
  57
  58 --shell::
  59 --perl::
  60 --python::
  61 --tcl::
  62         If given, strings that substitute `%(fieldname)`
  63         placeholders are quoted as string literals suitable for
  64         the specified host language.  This is meant to produce
  65         a scriptlet that can directly be `eval`ed.
  66
  67 --points-at <object>::
  68         Only list refs which points at the given object.
  69
  70 --merged [<object>]::
  71         Only list refs whose tips are reachable from the
  72         specified commit (HEAD if not specified).
  73
  74 --no-merged [<object>]::
  75         Only list refs whose tips are not reachable from the
  76         specified commit (HEAD if not specified).
  77
  78 --contains [<object>]::
  79         Only list tags which contain the specified commit (HEAD if not
  80         specified).
  81
  82 FIELD NAMES
  83 -----------
  84
  85 Various values from structured fields in referenced objects can
  86 be used to interpolate into the resulting output, or as sort
  87 keys.
  88
  89 For all objects, the following names can be used:
  90
  91 refname::
  92         The name of the ref (the part after $GIT_DIR/).
  93         For a non-ambiguous short name of the ref append `:short`.
  94         The option core.warnAmbiguousRefs is used to select the strict
  95         abbreviation mode.
  96
  97 objecttype::
  98         The type of the object (`blob`, `tree`, `commit`, `tag`).
  99
 100 objectsize::
 101         The size of the object (the same as 'git cat-file -s' reports).
 102
 103 objectname::
 104         The object name (aka SHA-1).
 105         For a non-ambiguous abbreviation of the object name append `:short`.
 106
 107 upstream::
 108         The name of a local ref which can be considered ``upstream''
 109         from the displayed ref. Respects `:short` in the same way as
 110         `refname` above.  Additionally respects `:track` to show
 111         "[ahead N, behind M]" and `:trackshort` to show the terse
 112         version: ">" (ahead), "<" (behind), "<>" (ahead and behind),
 113         or "=" (in sync).  Has no effect if the ref does not have
 114         tracking information associated with it.
 115
 116 push::
 117         The name of a local ref which represents the `@{push}` location
 118         for the displayed ref. Respects `:short`, `:track`, and
 119         `:trackshort` options as `upstream` does. Produces an empty
 120         string if no `@{push}` ref is configured.
 121
 122 HEAD::
 123         '*' if HEAD matches current ref (the checked out branch), ' '
 124         otherwise.
 125
 126 color::
 127         Change output color.  Followed by `:<colorname>`, where names
 128         are described in `color.branch.*`.
 129
 130 align::
 131         Left-, middle-, or right-align the content between
 132         %(align:...) and %(end). The "align:" is followed by `<width>`
 133         and `<position>` in any order separated by a comma, where the
 134         `<position>` is either left, right or middle, default being
 135         left and `<width>` is the total length of the content with
 136         alignment. If the contents length is more than the width then
 137         no alignment is performed. If used with '--quote' everything
 138         in between %(align:...) and %(end) is quoted, but if nested
 139         then only the topmost level performs quoting.
 140
 141 In addition to the above, for commit and tag objects, the header
 142 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
 143 be used to specify the value in the header field.
 144
 145 Fields that have name-email-date tuple as its value (`author`,
 146 `committer`, and `tagger`) can be suffixed with `name`, `email`,
 147 and `date` to extract the named component.
 148
 149 The complete message in a commit and tag object is `contents`.
 150 Its first line is `contents:subject`, where subject is the concatenation
 151 of all lines of the commit message up to the first blank line.  The next
 152 line is 'contents:body', where body is all of the lines after the first
 153 blank line.  The optional GPG signature is `contents:signature`.  The
 154 first `N` lines of the message is obtained using `contents:lines=N`.
 155
 156 For sorting purposes, fields with numeric values sort in numeric
 157 order (`objectsize`, `authordate`, `committerdate`, `taggerdate`).
 158 All other fields are used to sort in their byte-value order.
 159
 160 There is also an option to sort by versions, this can be done by using
 161 the fieldname `version:refname` or its alias `v:refname`.
 162
 163 In any case, a field name that refers to a field inapplicable to
 164 the object referred by the ref does not cause an error.  It
 165 returns an empty string instead.
 166
 167 As a special case for the date-type fields, you may specify a format for
 168 the date by adding `:` followed by date format name (see the
 169 values the `--date` option to linkgit::git-rev-list[1] takes).
 170
 171
 172 EXAMPLES
 173 --------
 174
 175 An example directly producing formatted text.  Show the most recent
 176 3 tagged commits:
 177
 178 ------------
 179 #!/bin/sh
 180
 181 git for-each-ref --count=3 --sort='-*authordate' \
 182 --format='From: %(*authorname) %(*authoremail)
 183 Subject: %(*subject)
 184 Date: %(*authordate)
 185 Ref: %(*refname)
 186
 187 %(*body)
 188 ' 'refs/tags'
 189 ------------
 190
 191
 192 A simple example showing the use of shell eval on the output,
 193 demonstrating the use of --shell.  List the prefixes of all heads:
 194 ------------
 195 #!/bin/sh
 196
 197 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
 198 while read entry
 199 do
 200         eval "$entry"
 201         echo `dirname $ref`
 202 done
 203 ------------
 204
 205
 206 A bit more elaborate report on tags, demonstrating that the format
 207 may be an entire script:
 208 ------------
 209 #!/bin/sh
 210
 211 fmt='
 212         r=%(refname)
 213         t=%(*objecttype)
 214         T=${r#refs/tags/}
 215
 216         o=%(*objectname)
 217         n=%(*authorname)
 218         e=%(*authoremail)
 219         s=%(*subject)
 220         d=%(*authordate)
 221         b=%(*body)
 222
 223         kind=Tag
 224         if test "z$t" = z
 225         then
 226                 # could be a lightweight tag
 227                 t=%(objecttype)
 228                 kind="Lightweight tag"
 229                 o=%(objectname)
 230                 n=%(authorname)
 231                 e=%(authoremail)
 232                 s=%(subject)
 233                 d=%(authordate)
 234                 b=%(body)
 235         fi
 236         echo "$kind $T points at a $t object $o"
 237         if test "z$t" = zcommit
 238         then
 239                 echo "The commit was authored by $n $e
 240 at $d, and titled
 241
 242     $s
 243
 244 Its message reads as:
 245 "
 246                 echo "$b" | sed -e "s/^/    /"
 247                 echo
 248         fi
 249 '
 250
 251 eval=`git for-each-ref --shell --format="$fmt" \
 252         --sort='*objecttype' \
 253         --sort=-taggerdate \
 254         refs/tags`
 255 eval "$eval"
 256 ------------
 257
 258 SEE ALSO
 259 --------
 260 linkgit:git-show-ref[1]
 261
 262 GIT
 263 ---
 264 Part of the linkgit:git[1] suite