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