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 - '%e': encoding
 138 - '%s': subject
 139 - '%f': sanitized subject line, suitable for a filename
 140 - '%b': body
 141 - '%B': raw body (unwrapped subject and body)
 142 ifndef::git-rev-list[]
 143 - '%N': commit notes
 144 endif::git-rev-list[]
 145 - '%GG': raw verification message from GPG for a signed commit
 146 - '%G?': show "G" for a good (valid) signature,
 147   "B" for a bad signature,
 148   "U" for a good signature with unknown validity,
 149   "X" for a good signature that has expired,
 150   "Y" for a good signature made by an expired key,
 151   "R" for a good signature made by a revoked key,
 152   "E" if the signature cannot be checked (e.g. missing key)
 153   and "N" for no signature
 154 - '%GS': show the name of the signer for a signed commit
 155 - '%GK': show the key used to sign a signed commit
 156 - '%gD': reflog selector, e.g., `refs/stash@{1}` or
 157   `refs/stash@{2 minutes ago`}; the format follows the rules described
 158   for the `-g` option. The portion before the `@` is the refname as
 159   given on the command line (so `git log -g refs/heads/master` would
 160   yield `refs/heads/master@{0}`).
 161 - '%gd': shortened reflog selector; same as `%gD`, but the refname
 162   portion is shortened for human readability (so `refs/heads/master`
 163   becomes just `master`).
 164 - '%gn': reflog identity name
 165 - '%gN': reflog identity name (respecting .mailmap, see
 166   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 167 - '%ge': reflog identity email
 168 - '%gE': reflog identity email (respecting .mailmap, see
 169   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 170 - '%gs': reflog subject
 171 - '%Cred': switch color to red
 172 - '%Cgreen': switch color to green
 173 - '%Cblue': switch color to blue
 174 - '%Creset': reset color
 175 - '%C(...)': color specification, as described under Values in the
 176   "CONFIGURATION FILE" section of linkgit:git-config[1];
 177   adding `auto,` at the beginning (e.g. `%C(auto,red)`) will emit
 178   color only when colors are enabled for log output (by `color.diff`,
 179   `color.ui`, or `--color`, and respecting the `auto` settings of the
 180   former if we are going to a terminal). `auto` alone (i.e.
 181   `%C(auto)`) will turn on auto coloring on the next placeholders
 182   until the color is switched again.
 183 - '%m': left (`<`), right (`>`) or boundary (`-`) mark
 184 - '%n': newline
 185 - '%%': a raw '%'
 186 - '%x00': print a byte from a hex code
 187 - '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of
 188   linkgit:git-shortlog[1].
 189 - '%<(<N>[,trunc|ltrunc|mtrunc])': make the next placeholder take at
 190   least N columns, padding spaces on the right if necessary.
 191   Optionally truncate at the beginning (ltrunc), the middle (mtrunc)
 192   or the end (trunc) if the output is longer than N columns.
 193   Note that truncating only works correctly with N >= 2.
 194 - '%<|(<N>)': make the next placeholder take at least until Nth
 195   columns, padding spaces on the right if necessary
 196 - '%>(<N>)', '%>|(<N>)': similar to '%<(<N>)', '%<|(<N>)'
 197   respectively, but padding spaces on the left
 198 - '%>>(<N>)', '%>>|(<N>)': similar to '%>(<N>)', '%>|(<N>)'
 199   respectively, except that if the next placeholder takes more spaces
 200   than given and there are spaces on its left, use those spaces
 201 - '%><(<N>)', '%><|(<N>)': similar to '% <(<N>)', '%<|(<N>)'
 202   respectively, but padding both sides (i.e. the text is centered)
 203 - %(trailers): display the trailers of the body as interpreted by
 204   linkgit:git-interpret-trailers[1]
 205
 206 NOTE: Some placeholders may depend on other options given to the
 207 revision traversal engine. For example, the `%g*` reflog options will
 208 insert an empty string unless we are traversing reflog entries (e.g., by
 209 `git log -g`). The `%d` and `%D` placeholders will use the "short"
 210 decoration format if `--decorate` was not already provided on the command
 211 line.
 212
 213 If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
 214 is inserted immediately before the expansion if and only if the
 215 placeholder expands to a non-empty string.
 216
 217 If you add a `-` (minus sign) after '%' of a placeholder, all consecutive
 218 line-feeds immediately preceding the expansion are deleted if and only if the
 219 placeholder expands to an empty string.
 220
 221 If you add a ` ` (space) after '%' of a placeholder, a space
 222 is inserted immediately before the expansion if and only if the
 223 placeholder expands to a non-empty string.
 224
 225 * 'tformat:'
 226 +
 227 The 'tformat:' format works exactly like 'format:', except that it
 228 provides "terminator" semantics instead of "separator" semantics. In
 229 other words, each commit has the message terminator character (usually a
 230 newline) appended, rather than a separator placed between entries.
 231 This means that the final entry of a single-line format will be properly
 232 terminated with a new line, just as the "oneline" format does.
 233 For example:
 234 +
 235 ---------------------
 236 $ git log -2 --pretty=format:%h 4da45bef \
 237   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 238 4da45be
 239 7134973 -- NO NEWLINE
 240
 241 $ git log -2 --pretty=tformat:%h 4da45bef \
 242   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 243 4da45be
 244 7134973
 245 ---------------------
 246 +
 247 In addition, any unrecognized string that has a `%` in it is interpreted
 248 as if it has `tformat:` in front of it.  For example, these two are
 249 equivalent:
 250 +
 251 ---------------------
 252 $ git log -2 --pretty=tformat:%h 4da45bef
 253 $ git log -2 --pretty=%h 4da45bef
 254 ---------------------