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 - '%H': commit hash
 106 - '%h': abbreviated commit hash
 107 - '%T': tree hash
 108 - '%t': abbreviated tree hash
 109 - '%P': parent hashes
 110 - '%p': abbreviated parent hashes
 111 - '%an': author name
 112 - '%aN': author name (respecting .mailmap, see linkgit:git-shortlog[1]
 113   or linkgit:git-blame[1])
 114 - '%ae': author email
 115 - '%aE': author email (respecting .mailmap, see
 116   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 117 - '%ad': author date (format respects --date= option)
 118 - '%aD': author date, RFC2822 style
 119 - '%ar': author date, relative
 120 - '%at': author date, UNIX timestamp
 121 - '%ai': author date, ISO 8601-like format
 122 - '%aI': author date, strict ISO 8601 format
 123 - '%cn': committer name
 124 - '%cN': committer name (respecting .mailmap, see
 125   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 126 - '%ce': committer email
 127 - '%cE': committer email (respecting .mailmap, see
 128   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 129 - '%cd': committer date (format respects --date= option)
 130 - '%cD': committer date, RFC2822 style
 131 - '%cr': committer date, relative
 132 - '%ct': committer date, UNIX timestamp
 133 - '%ci': committer date, ISO 8601-like format
 134 - '%cI': committer date, strict ISO 8601 format
 135 - '%d': ref names, like the --decorate option of linkgit:git-log[1]
 136 - '%D': ref names without the " (", ")" wrapping.
 137 - '%S': ref name given on the command line by which the commit was reached
 138   (like `git log --source`), only works with `git log`
 139 - '%e': encoding
 140 - '%s': subject
 141 - '%f': sanitized subject line, suitable for a filename
 142 - '%b': body
 143 - '%B': raw body (unwrapped subject and body)
 144 ifndef::git-rev-list[]
 145 - '%N': commit notes
 146 endif::git-rev-list[]
 147 - '%GG': raw verification message from GPG for a signed commit
 148 - '%G?': show "G" for a good (valid) signature,
 149   "B" for a bad signature,
 150   "U" for a good signature with unknown validity,
 151   "X" for a good signature that has expired,
 152   "Y" for a good signature made by an expired key,
 153   "R" for a good signature made by a revoked key,
 154   "E" if the signature cannot be checked (e.g. missing key)
 155   and "N" for no signature
 156 - '%GS': show the name of the signer for a signed commit
 157 - '%GK': show the key used to sign a signed commit
 158 - '%GF': show the fingerprint of the key used to sign a signed commit
 159 - '%GP': show the fingerprint of the primary key whose subkey was used
 160   to sign a signed commit
 161 - '%gD': reflog selector, e.g., `refs/stash@{1}` or
 162   `refs/stash@{2 minutes ago`}; the format follows the rules described
 163   for the `-g` option. The portion before the `@` is the refname as
 164   given on the command line (so `git log -g refs/heads/master` would
 165   yield `refs/heads/master@{0}`).
 166 - '%gd': shortened reflog selector; same as `%gD`, but the refname
 167   portion is shortened for human readability (so `refs/heads/master`
 168   becomes just `master`).
 169 - '%gn': reflog identity name
 170 - '%gN': reflog identity name (respecting .mailmap, see
 171   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 172 - '%ge': reflog identity email
 173 - '%gE': reflog identity email (respecting .mailmap, see
 174   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 175 - '%gs': reflog subject
 176 - '%Cred': switch color to red
 177 - '%Cgreen': switch color to green
 178 - '%Cblue': switch color to blue
 179 - '%Creset': reset color
 180 - '%C(...)': color specification, as described under Values in the
 181   "CONFIGURATION FILE" section of linkgit:git-config[1].
 182   By default, colors are shown only when enabled for log output (by
 183   `color.diff`, `color.ui`, or `--color`, and respecting the `auto`
 184   settings of the former if we are going to a terminal). `%C(auto,...)`
 185   is accepted as a historical synonym for the default (e.g.,
 186   `%C(auto,red)`). Specifying `%C(always,...)` will show the colors
 187   even when color is not otherwise enabled (though consider
 188   just using `--color=always` to enable color for the whole output,
 189   including this format and anything else git might color).  `auto`
 190   alone (i.e. `%C(auto)`) will turn on auto coloring on the next
 191   placeholders until the color is switched again.
 192 - '%m': left (`<`), right (`>`) or boundary (`-`) mark
 193 - '%n': newline
 194 - '%%': a raw '%'
 195 - '%x00': print a byte from a hex code
 196 - '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of
 197   linkgit:git-shortlog[1].
 198 - '%<(<N>[,trunc|ltrunc|mtrunc])': make the next placeholder take at
 199   least N columns, padding spaces on the right if necessary.
 200   Optionally truncate at the beginning (ltrunc), the middle (mtrunc)
 201   or the end (trunc) if the output is longer than N columns.
 202   Note that truncating only works correctly with N >= 2.
 203 - '%<|(<N>)': make the next placeholder take at least until Nth
 204   columns, padding spaces on the right if necessary
 205 - '%>(<N>)', '%>|(<N>)': similar to '%<(<N>)', '%<|(<N>)'
 206   respectively, but padding spaces on the left
 207 - '%>>(<N>)', '%>>|(<N>)': similar to '%>(<N>)', '%>|(<N>)'
 208   respectively, except that if the next placeholder takes more spaces
 209   than given and there are spaces on its left, use those spaces
 210 - '%><(<N>)', '%><|(<N>)': similar to '%<(<N>)', '%<|(<N>)'
 211   respectively, but padding both sides (i.e. the text is centered)
 212 - %(trailers[:options]): display the trailers of the body as interpreted
 213   by linkgit:git-interpret-trailers[1]. The `trailers` string may be
 214   followed by a colon and zero or more comma-separated options. If the
 215   `only` option is given, omit non-trailer lines from the trailer block.
 216   If the `unfold` option is given, behave as if interpret-trailer's
 217   `--unfold` option was given.  E.g., `%(trailers:only,unfold)` to do
 218   both.
 219
 220 NOTE: Some placeholders may depend on other options given to the
 221 revision traversal engine. For example, the `%g*` reflog options will
 222 insert an empty string unless we are traversing reflog entries (e.g., by
 223 `git log -g`). The `%d` and `%D` placeholders will use the "short"
 224 decoration format if `--decorate` was not already provided on the command
 225 line.
 226
 227 If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
 228 is inserted immediately before the expansion if and only if the
 229 placeholder expands to a non-empty string.
 230
 231 If you add a `-` (minus sign) after '%' of a placeholder, all consecutive
 232 line-feeds immediately preceding the expansion are deleted if and only if the
 233 placeholder expands to an empty string.
 234
 235 If you add a ` ` (space) after '%' of a placeholder, a space
 236 is inserted immediately before the expansion if and only if the
 237 placeholder expands to a non-empty string.
 238
 239 * 'tformat:'
 240 +
 241 The 'tformat:' format works exactly like 'format:', except that it
 242 provides "terminator" semantics instead of "separator" semantics. In
 243 other words, each commit has the message terminator character (usually a
 244 newline) appended, rather than a separator placed between entries.
 245 This means that the final entry of a single-line format will be properly
 246 terminated with a new line, just as the "oneline" format does.
 247 For example:
 248 +
 249 ---------------------
 250 $ git log -2 --pretty=format:%h 4da45bef \
 251   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 252 4da45be
 253 7134973 -- NO NEWLINE
 254
 255 $ git log -2 --pretty=tformat:%h 4da45bef \
 256   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 257 4da45be
 258 7134973
 259 ---------------------
 260 +
 261 In addition, any unrecognized string that has a `%` in it is interpreted
 262 as if it has `tformat:` in front of it.  For example, these two are
 263 equivalent:
 264 +
 265 ---------------------
 266 $ git log -2 --pretty=tformat:%h 4da45bef
 267 $ git log -2 --pretty=%h 4da45bef
 268 ---------------------