Documentation / pretty-formats.txton commit Merge branch 'jl/use-vsatisfy-correctly-for-2.0' (5714722)
   1PRETTY FORMATS
   2--------------
   3
   4If the commit is a merge, and if the pretty-format
   5is not 'oneline', 'email' or 'raw', an additional line is
   6inserted before the 'Author:' line.  This line begins with
   7"Merge: " and the sha1s of ancestral commits are printed,
   8separated by spaces.  Note that the listed commits may not
   9necessarily be the list of the *direct* parent commits if you
  10have limited your view of history: for example, if you are
  11only interested in changes related to a certain directory or
  12file.
  13
  14There are several built-in formats, and you can define
  15additional formats by setting a pretty.<name>
  16config option to either another format name, or a
  17'format:' string, as described below (see
  18linkgit:git-config[1]). Here are the details of the
  19built-in formats:
  20
  21* 'oneline'
  22
  23          <sha1> <title line>
  24+
  25This 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+
  77The 'raw' format shows the entire commit exactly as
  78stored in the commit object.  Notably, the SHA-1s are
  79displayed in full, regardless of whether --abbrev or
  80--no-abbrev are used, and 'parents' information show the
  81true parent commits, without taking grafts or history
  82simplification into account.
  83
  84* 'format:<string>'
  85+
  86The 'format:<string>' format allows you to specify which information
  87you want to show. It works a little bit like printf format,
  88with the notable exception that you get a newline with '%n'
  89instead of '\n'.
  90+
  91E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
  92would show something like this:
  93+
  94-------
  95The author of fe6e0ee was Junio C Hamano, 23 hours ago
  96The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
  97
  98--------
  99+
 100The placeholders are:
 101
 102- '%H': commit hash
 103- '%h': abbreviated commit hash
 104- '%T': tree hash
 105- '%t': abbreviated tree hash
 106- '%P': parent hashes
 107- '%p': abbreviated parent hashes
 108- '%an': author name
 109- '%aN': author name (respecting .mailmap, see linkgit:git-shortlog[1]
 110  or linkgit:git-blame[1])
 111- '%ae': author email
 112- '%aE': author email (respecting .mailmap, see
 113  linkgit:git-shortlog[1] or linkgit:git-blame[1])
 114- '%ad': author date (format respects --date= option)
 115- '%aD': author date, RFC2822 style
 116- '%ar': author date, relative
 117- '%at': author date, UNIX timestamp
 118- '%ai': author date, ISO 8601 format
 119- '%cn': committer name
 120- '%cN': committer name (respecting .mailmap, see
 121  linkgit:git-shortlog[1] or linkgit:git-blame[1])
 122- '%ce': committer email
 123- '%cE': committer email (respecting .mailmap, see
 124  linkgit:git-shortlog[1] or linkgit:git-blame[1])
 125- '%cd': committer date
 126- '%cD': committer date, RFC2822 style
 127- '%cr': committer date, relative
 128- '%ct': committer date, UNIX timestamp
 129- '%ci': committer date, ISO 8601 format
 130- '%d': ref names, like the --decorate option of linkgit:git-log[1]
 131- '%e': encoding
 132- '%s': subject
 133- '%f': sanitized subject line, suitable for a filename
 134- '%b': body
 135- '%B': raw body (unwrapped subject and body)
 136- '%N': commit notes
 137- '%GG': raw verification message from GPG for a signed commit
 138- '%G?': show "G" for a Good signature, "B" for a Bad signature, "U" for a good,
 139  untrusted signature and "N" for no signature
 140- '%GS': show the name of the signer for a signed commit
 141- '%GK': show the key used to sign a signed commit
 142- '%gD': reflog selector, e.g., `refs/stash@{1}`
 143- '%gd': shortened reflog selector, e.g., `stash@{1}`
 144- '%gn': reflog identity name
 145- '%gN': reflog identity name (respecting .mailmap, see
 146  linkgit:git-shortlog[1] or linkgit:git-blame[1])
 147- '%ge': reflog identity email
 148- '%gE': reflog identity email (respecting .mailmap, see
 149  linkgit:git-shortlog[1] or linkgit:git-blame[1])
 150- '%gs': reflog subject
 151- '%Cred': switch color to red
 152- '%Cgreen': switch color to green
 153- '%Cblue': switch color to blue
 154- '%Creset': reset color
 155- '%C(...)': color specification, as described in color.branch.* config option;
 156  adding `auto,` at the beginning will emit color only when colors are
 157  enabled for log output (by `color.diff`, `color.ui`, or `--color`, and
 158  respecting the `auto` settings of the former if we are going to a
 159  terminal). `auto` alone (i.e. `%C(auto)`) will turn on auto coloring
 160  on the next placeholders until the color is switched again.
 161- '%m': left, right or boundary mark
 162- '%n': newline
 163- '%%': a raw '%'
 164- '%x00': print a byte from a hex code
 165- '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of
 166  linkgit:git-shortlog[1].
 167- '%<(<N>[,trunc|ltrunc|mtrunc])': make the next placeholder take at
 168  least N columns, padding spaces on the right if necessary.
 169  Optionally truncate at the beginning (ltrunc), the middle (mtrunc)
 170  or the end (trunc) if the output is longer than N columns.
 171  Note that truncating only works correctly with N >= 2.
 172- '%<|(<N>)': make the next placeholder take at least until Nth
 173  columns, padding spaces on the right if necessary
 174- '%>(<N>)', '%>|(<N>)': similar to '%<(<N>)', '%<|(<N>)'
 175  respectively, but padding spaces on the left
 176- '%>>(<N>)', '%>>|(<N>)': similar to '%>(<N>)', '%>|(<N>)'
 177  respectively, except that if the next placeholder takes more spaces
 178  than given and there are spaces on its left, use those spaces
 179- '%><(<N>)', '%><|(<N>)': similar to '% <(<N>)', '%<|(<N>)'
 180  respectively, but padding both sides (i.e. the text is centered)
 181
 182NOTE: Some placeholders may depend on other options given to the
 183revision traversal engine. For example, the `%g*` reflog options will
 184insert an empty string unless we are traversing reflog entries (e.g., by
 185`git log -g`). The `%d` placeholder will use the "short" decoration
 186format if `--decorate` was not already provided on the command line.
 187
 188If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
 189is inserted immediately before the expansion if and only if the
 190placeholder expands to a non-empty string.
 191
 192If you add a `-` (minus sign) after '%' of a placeholder, line-feeds that
 193immediately precede the expansion are deleted if and only if the
 194placeholder expands to an empty string.
 195
 196If you add a ` ` (space) after '%' of a placeholder, a space
 197is inserted immediately before the expansion if and only if the
 198placeholder expands to a non-empty string.
 199
 200* 'tformat:'
 201+
 202The 'tformat:' format works exactly like 'format:', except that it
 203provides "terminator" semantics instead of "separator" semantics. In
 204other words, each commit has the message terminator character (usually a
 205newline) appended, rather than a separator placed between entries.
 206This means that the final entry of a single-line format will be properly
 207terminated with a new line, just as the "oneline" format does.
 208For example:
 209+
 210---------------------
 211$ git log -2 --pretty=format:%h 4da45bef \
 212  | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 2134da45be
 2147134973 -- NO NEWLINE
 215
 216$ git log -2 --pretty=tformat:%h 4da45bef \
 217  | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 2184da45be
 2197134973
 220---------------------
 221+
 222In addition, any unrecognized string that has a `%` in it is interpreted
 223as if it has `tformat:` in front of it.  For example, these two are
 224equivalent:
 225+
 226---------------------
 227$ git log -2 --pretty=tformat:%h 4da45bef
 228$ git log -2 --pretty=%h 4da45bef
 229---------------------