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 format
 122 - '%cn': committer name
 123 - '%cN': committer name (respecting .mailmap, see
 124   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 125 - '%ce': committer email
 126 - '%cE': committer email (respecting .mailmap, see
 127   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 128 - '%cd': committer date
 129 - '%cD': committer date, RFC2822 style
 130 - '%cr': committer date, relative
 131 - '%ct': committer date, UNIX timestamp
 132 - '%ci': committer date, ISO 8601 format
 133 - '%d': ref names, like the --decorate option of linkgit:git-log[1]
 134 - '%e': encoding
 135 - '%s': subject
 136 - '%f': sanitized subject line, suitable for a filename
 137 - '%b': body
 138 - '%B': raw body (unwrapped subject and body)
 139 - '%N': commit notes
 140 - '%GG': raw verification message from GPG for a signed commit
 141 - '%G?': show "G" for a Good signature, "B" for a Bad signature, "U" for a good,
 142   untrusted signature and "N" for no signature
 143 - '%GS': show the name of the signer for a signed commit
 144 - '%GK': show the key used to sign a signed commit
 145 - '%gD': reflog selector, e.g., `refs/stash@{1}`
 146 - '%gd': shortened reflog selector, e.g., `stash@{1}`
 147 - '%gn': reflog identity name
 148 - '%gN': reflog identity name (respecting .mailmap, see
 149   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 150 - '%ge': reflog identity email
 151 - '%gE': reflog identity email (respecting .mailmap, see
 152   linkgit:git-shortlog[1] or linkgit:git-blame[1])
 153 - '%gs': reflog subject
 154 - '%Cred': switch color to red
 155 - '%Cgreen': switch color to green
 156 - '%Cblue': switch color to blue
 157 - '%Creset': reset color
 158 - '%C(...)': color specification, as described in color.branch.* config option;
 159   adding `auto,` at the beginning will emit color only when colors are
 160   enabled for log output (by `color.diff`, `color.ui`, or `--color`, and
 161   respecting the `auto` settings of the former if we are going to a
 162   terminal). `auto` alone (i.e. `%C(auto)`) will turn on auto coloring
 163   on the next placeholders until the color is switched again.
 164 - '%m': left, right or boundary mark
 165 - '%n': newline
 166 - '%%': a raw '%'
 167 - '%x00': print a byte from a hex code
 168 - '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of
 169   linkgit:git-shortlog[1].
 170 - '%<(<N>[,trunc|ltrunc|mtrunc])': make the next placeholder take at
 171   least N columns, padding spaces on the right if necessary.
 172   Optionally truncate at the beginning (ltrunc), the middle (mtrunc)
 173   or the end (trunc) if the output is longer than N columns.
 174   Note that truncating only works correctly with N >= 2.
 175 - '%<|(<N>)': make the next placeholder take at least until Nth
 176   columns, padding spaces on the right if necessary
 177 - '%>(<N>)', '%>|(<N>)': similar to '%<(<N>)', '%<|(<N>)'
 178   respectively, but padding spaces on the left
 179 - '%>>(<N>)', '%>>|(<N>)': similar to '%>(<N>)', '%>|(<N>)'
 180   respectively, except that if the next placeholder takes more spaces
 181   than given and there are spaces on its left, use those spaces
 182 - '%><(<N>)', '%><|(<N>)': similar to '% <(<N>)', '%<|(<N>)'
 183   respectively, but padding both sides (i.e. the text is centered)
 184
 185 NOTE: Some placeholders may depend on other options given to the
 186 revision traversal engine. For example, the `%g*` reflog options will
 187 insert an empty string unless we are traversing reflog entries (e.g., by
 188 `git log -g`). The `%d` placeholder will use the "short" decoration
 189 format if `--decorate` was not already provided on the command line.
 190
 191 If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
 192 is inserted immediately before the expansion if and only if the
 193 placeholder expands to a non-empty string.
 194
 195 If you add a `-` (minus sign) after '%' of a placeholder, line-feeds that
 196 immediately precede the expansion are deleted if and only if the
 197 placeholder expands to an empty string.
 198
 199 If you add a ` ` (space) after '%' of a placeholder, a space
 200 is inserted immediately before the expansion if and only if the
 201 placeholder expands to a non-empty string.
 202
 203 * 'tformat:'
 204 +
 205 The 'tformat:' format works exactly like 'format:', except that it
 206 provides "terminator" semantics instead of "separator" semantics. In
 207 other words, each commit has the message terminator character (usually a
 208 newline) appended, rather than a separator placed between entries.
 209 This means that the final entry of a single-line format will be properly
 210 terminated with a new line, just as the "oneline" format does.
 211 For example:
 212 +
 213 ---------------------
 214 $ git log -2 --pretty=format:%h 4da45bef \
 215   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 216 4da45be
 217 7134973 -- NO NEWLINE
 218
 219 $ git log -2 --pretty=tformat:%h 4da45bef \
 220   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 221 4da45be
 222 7134973
 223 ---------------------
 224 +
 225 In addition, any unrecognized string that has a `%` in it is interpreted
 226 as if it has `tformat:` in front of it.  For example, these two are
 227 equivalent:
 228 +
 229 ---------------------
 230 $ git log -2 --pretty=tformat:%h 4da45bef
 231 $ git log -2 --pretty=%h 4da45bef
 232 ---------------------