Documentation/pretty-formats.txt

   1 PRETTY FORMATS
   2 --------------
   3
   4 If the commit is a merge, and if the pretty-format
   5 is not 'oneline', 'email' or 'raw', an additional line is
   6 inserted before the 'Author:' line.  This line begins with
   7 "Merge: " and the sha1s of ancestral commits are printed,
   8 separated by spaces.  Note that the listed commits may not
   9 necessarily be the list of the *direct* parent commits if you
  10 have limited your view of history: for example, if you are
  11 only interested in changes related to a certain directory or
  12 file.
  13
  14 There are several built-in formats, and you can define
  15 additional formats by setting a pretty.<name>
  16 config option to either another format name, or a
  17 'format:' string, as described below (see
  18 linkgit:git-config[1]). Here are the details of the
  19 built-in formats:
  20
  21 * 'oneline'
  22
  23           <sha1> <title line>
  24 +
  25 This is designed to be as compact as possible.
  26
  27 * 'short'
  28
  29           commit <sha1>
  30           Author: <author>
  31
  32               <title line>
  33
  34 * 'medium'
  35
  36           commit <sha1>
  37           Author: <author>
  38           Date:   <author date>
  39
  40               <title line>
  41
  42               <full commit message>
  43
  44 * 'full'
  45
  46           commit <sha1>
  47           Author: <author>
  48           Commit: <committer>
  49
  50               <title line>
  51
  52               <full commit message>
  53
  54 * 'fuller'
  55
  56           commit <sha1>
  57           Author:     <author>
  58           AuthorDate: <author date>
  59           Commit:     <committer>
  60           CommitDate: <committer date>
  61
  62                <title line>
  63
  64                <full commit message>
  65
  66 * 'email'
  67
  68           From <sha1> <date>
  69           From: <author>
  70           Date: <author date>
  71           Subject: [PATCH] <title line>
  72
  73           <full commit message>
  74
  75 * 'raw'
  76 +
  77 The 'raw' format shows the entire commit exactly as
  78 stored in the commit object.  Notably, the SHA-1s are
  79 displayed in full, regardless of whether --abbrev or
  80 --no-abbrev are used, and 'parents' information show the
  81 true parent commits, without taking grafts or history
  82 simplification into account. Note that this format affects the way
  83 commits are displayed, but not the way the diff is shown e.g. with
  84 `git log --raw`. To get full object names in a raw diff format,
  85 use `--no-abbrev`.
  86
  87 * 'format:<string>'
  88 +
  89 The 'format:<string>' format allows you to specify which information
  90 you want to show. It works a little bit like printf format,
  91 with the notable exception that you get a newline with '%n'
  92 instead of '\n'.
  93 +
  94 E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
  95 would show something like this:
  96 +
  97 -------
  98 The author of fe6e0ee was Junio C Hamano, 23 hours ago
  99 The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
 100
 101 -------
 102 +
 103 The placeholders are:
 104
 105 - Placeholders that expand to a single literal character:
 106 '%n':: newline
 107 '%%':: a raw '%'
 108 '%x00':: print a byte from a hex code
 109
 110 - Placeholders that affect formatting of later placeholders:
 111 '%Cred':: switch color to red
 112 '%Cgreen':: switch color to green
 113 '%Cblue':: switch color to blue
 114 '%Creset':: reset color
 115 '%C(...)':: color specification, as described under Values in the
 116             "CONFIGURATION FILE" section of linkgit:git-config[1].  By
 117             default, colors are shown only when enabled for log output
 118             (by `color.diff`, `color.ui`, or `--color`, and respecting
 119             the `auto` settings of the former if we are going to a
 120             terminal). `%C(auto,...)` is accepted as a historical
 121             synonym for the default (e.g., `%C(auto,red)`). Specifying
 122             `%C(always,...)` will show the colors even when color is
 123             not otherwise enabled (though consider just using
 124             `--color=always` to enable color for the whole output,
 125             including this format and anything else git might color).
 126             `auto` alone (i.e. `%C(auto)`) will turn on auto coloring
 127             on the next placeholders until the color is switched
 128             again.
 129 '%m':: left (`<`), right (`>`) or boundary (`-`) mark
 130 '%w([<w>[,<i1>[,<i2>]]])':: switch line wrapping, like the -w option of
 131                             linkgit:git-shortlog[1].
 132 '%<(<N>[,trunc|ltrunc|mtrunc])':: make the next placeholder take at
 133                                   least N columns, padding spaces on
 134                                   the right if necessary.  Optionally
 135                                   truncate at the beginning (ltrunc),
 136                                   the middle (mtrunc) or the end
 137                                   (trunc) if the output is longer than
 138                                   N columns.  Note that truncating
 139                                   only works correctly with N >= 2.
 140 '%<|(<N>)':: make the next placeholder take at least until Nth
 141              columns, padding spaces on the right if necessary
 142 '%>(<N>)', '%>|(<N>)':: similar to '%<(<N>)', '%<|(<N>)' respectively,
 143                         but padding spaces on the left
 144 '%>>(<N>)', '%>>|(<N>)':: similar to '%>(<N>)', '%>|(<N>)'
 145                           respectively, except that if the next
 146                           placeholder takes more spaces than given and
 147                           there are spaces on its left, use those
 148                           spaces
 149 '%><(<N>)', '%><|(<N>)':: similar to '%<(<N>)', '%<|(<N>)'
 150                           respectively, but padding both sides
 151                           (i.e. the text is centered)
 152
 153 - Placeholders that expand to information extracted from the commit:
 154 '%H':: commit hash
 155 '%h':: abbreviated commit hash
 156 '%T':: tree hash
 157 '%t':: abbreviated tree hash
 158 '%P':: parent hashes
 159 '%p':: abbreviated parent hashes
 160 '%an':: author name
 161 '%aN':: author name (respecting .mailmap, see linkgit:git-shortlog[1]
 162         or linkgit:git-blame[1])
 163 '%ae':: author email
 164 '%aE':: author email (respecting .mailmap, see linkgit:git-shortlog[1]
 165         or linkgit:git-blame[1])
 166 '%ad':: author date (format respects --date= option)
 167 '%aD':: author date, RFC2822 style
 168 '%ar':: author date, relative
 169 '%at':: author date, UNIX timestamp
 170 '%ai':: author date, ISO 8601-like format
 171 '%aI':: author date, strict ISO 8601 format
 172 '%cn':: committer name
 173 '%cN':: committer name (respecting .mailmap, see
 174         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 175 '%ce':: committer email
 176 '%cE':: committer email (respecting .mailmap, see
 177         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 178 '%cd':: committer date (format respects --date= option)
 179 '%cD':: committer date, RFC2822 style
 180 '%cr':: committer date, relative
 181 '%ct':: committer date, UNIX timestamp
 182 '%ci':: committer date, ISO 8601-like format
 183 '%cI':: committer date, strict ISO 8601 format
 184 '%d':: ref names, like the --decorate option of linkgit:git-log[1]
 185 '%D':: ref names without the " (", ")" wrapping.
 186 '%S':: ref name given on the command line by which the commit was reached
 187        (like `git log --source`), only works with `git log`
 188 '%e':: encoding
 189 '%s':: subject
 190 '%f':: sanitized subject line, suitable for a filename
 191 '%b':: body
 192 '%B':: raw body (unwrapped subject and body)
 193 ifndef::git-rev-list[]
 194 '%N':: commit notes
 195 endif::git-rev-list[]
 196 '%GG':: raw verification message from GPG for a signed commit
 197 '%G?':: show "G" for a good (valid) signature,
 198         "B" for a bad signature,
 199         "U" for a good signature with unknown validity,
 200         "X" for a good signature that has expired,
 201         "Y" for a good signature made by an expired key,
 202         "R" for a good signature made by a revoked key,
 203         "E" if the signature cannot be checked (e.g. missing key)
 204         and "N" for no signature
 205 '%GS':: show the name of the signer for a signed commit
 206 '%GK':: show the key used to sign a signed commit
 207 '%GF':: show the fingerprint of the key used to sign a signed commit
 208 '%GP':: show the fingerprint of the primary key whose subkey was used
 209         to sign a signed commit
 210 '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
 211         minutes ago}`; the format follows the rules described for the
 212         `-g` option. The portion before the `@` is the refname as
 213         given on the command line (so `git log -g refs/heads/master`
 214         would yield `refs/heads/master@{0}`).
 215 '%gd':: shortened reflog selector; same as `%gD`, but the refname
 216         portion is shortened for human readability (so
 217         `refs/heads/master` becomes just `master`).
 218 '%gn':: reflog identity name
 219 '%gN':: reflog identity name (respecting .mailmap, see
 220         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 221 '%ge':: reflog identity email
 222 '%gE':: reflog identity email (respecting .mailmap, see
 223         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 224 '%gs':: reflog subject
 225 '%(trailers[:options])':: display the trailers of the body as
 226                           interpreted by
 227                           linkgit:git-interpret-trailers[1]. The
 228                           `trailers` string may be followed by a colon
 229                           and zero or more comma-separated options:
 230 ** 'key=<K>': only show trailers with specified key. Matching is done
 231    case-insensitively and trailing colon is optional. If option is
 232    given multiple times trailer lines matching any of the keys are
 233    shown. This option automatically enables the `only` option so that
 234    non-trailer lines in the trailer block are hidden. If that is not
 235    desired it can be disabled with `only=false`.  E.g.,
 236    `%(trailers:key=Reviewed-by)` shows trailer lines with key
 237    `Reviewed-by`.
 238 ** 'only[=val]': select whether non-trailer lines from the trailer
 239    block should be included. The `only` keyword may optionally be
 240    followed by an equal sign and one of `true`, `on`, `yes` to omit or
 241    `false`, `off`, `no` to show the non-trailer lines. If option is
 242    given without value it is enabled. If given multiple times the last
 243    value is used.
 244 ** 'separator=<SEP>': specify a separator inserted between trailer
 245    lines. When this option is not given each trailer line is
 246    terminated with a line feed character. The string SEP may contain
 247    the literal formatting codes described above. To use comma as
 248    separator one must use `%x2C` as it would otherwise be parsed as
 249    next option. If separator option is given multiple times only the
 250    last one is used. E.g., `%(trailers:key=Ticket,separator=%x2C )`
 251    shows all trailer lines whose key is "Ticket" separated by a comma
 252    and a space.
 253 ** 'unfold[=val]': make it behave as if interpret-trailer's `--unfold`
 254    option was given. In same way as to for `only` it can be followed
 255    by an equal sign and explicit value. E.g.,
 256    `%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
 257 ** 'valueonly[=val]': skip over the key part of the trailer line and only
 258    show the value part. Also this optionally allows explicit value.
 259
 260 NOTE: Some placeholders may depend on other options given to the
 261 revision traversal engine. For example, the `%g*` reflog options will
 262 insert an empty string unless we are traversing reflog entries (e.g., by
 263 `git log -g`). The `%d` and `%D` placeholders will use the "short"
 264 decoration format if `--decorate` was not already provided on the command
 265 line.
 266
 267 If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
 268 is inserted immediately before the expansion if and only if the
 269 placeholder expands to a non-empty string.
 270
 271 If you add a `-` (minus sign) after '%' of a placeholder, all consecutive
 272 line-feeds immediately preceding the expansion are deleted if and only if the
 273 placeholder expands to an empty string.
 274
 275 If you add a ` ` (space) after '%' of a placeholder, a space
 276 is inserted immediately before the expansion if and only if the
 277 placeholder expands to a non-empty string.
 278
 279 * 'tformat:'
 280 +
 281 The 'tformat:' format works exactly like 'format:', except that it
 282 provides "terminator" semantics instead of "separator" semantics. In
 283 other words, each commit has the message terminator character (usually a
 284 newline) appended, rather than a separator placed between entries.
 285 This means that the final entry of a single-line format will be properly
 286 terminated with a new line, just as the "oneline" format does.
 287 For example:
 288 +
 289 ---------------------
 290 $ git log -2 --pretty=format:%h 4da45bef \
 291   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 292 4da45be
 293 7134973 -- NO NEWLINE
 294
 295 $ git log -2 --pretty=tformat:%h 4da45bef \
 296   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 297 4da45be
 298 7134973
 299 ---------------------
 300 +
 301 In addition, any unrecognized string that has a `%` in it is interpreted
 302 as if it has `tformat:` in front of it.  For example, these two are
 303 equivalent:
 304 +
 305 ---------------------
 306 $ git log -2 --pretty=tformat:%h 4da45bef
 307 $ git log -2 --pretty=%h 4da45bef
 308 ---------------------