Documentation / pretty-formats.txton commit doc/read-tree: remove obsolete remark (30221a3)
   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. Note that this format affects the way
  83commits 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,
  85use `--no-abbrev`.
  86
  87* 'format:<string>'
  88+
  89The 'format:<string>' format allows you to specify which information
  90you want to show. It works a little bit like printf format,
  91with the notable exception that you get a newline with '%n'
  92instead of '\n'.
  93+
  94E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
  95would show something like this:
  96+
  97-------
  98The author of fe6e0ee was Junio C Hamano, 23 hours ago
  99The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
 100
 101-------
 102+
 103The 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)
 142ifndef::git-rev-list[]
 143- '%N': commit notes
 144endif::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 under Values in the
 170  "CONFIGURATION FILE" section of linkgit:git-config[1];
 171  adding `auto,` at the beginning will emit color only when colors are
 172  enabled for log output (by `color.diff`, `color.ui`, or `--color`, and
 173  respecting the `auto` settings of the former if we are going to a
 174  terminal). `auto` alone (i.e. `%C(auto)`) will turn on auto coloring
 175  on the next placeholders until the color is switched again.
 176- '%m': left (`<`), right (`>`) or boundary (`-`) mark
 177- '%n': newline
 178- '%%': a raw '%'
 179- '%x00': print a byte from a hex code
 180- '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of
 181  linkgit:git-shortlog[1].
 182- '%<(<N>[,trunc|ltrunc|mtrunc])': make the next placeholder take at
 183  least N columns, padding spaces on the right if necessary.
 184  Optionally truncate at the beginning (ltrunc), the middle (mtrunc)
 185  or the end (trunc) if the output is longer than N columns.
 186  Note that truncating only works correctly with N >= 2.
 187- '%<|(<N>)': make the next placeholder take at least until Nth
 188  columns, padding spaces on the right if necessary
 189- '%>(<N>)', '%>|(<N>)': similar to '%<(<N>)', '%<|(<N>)'
 190  respectively, but padding spaces on the left
 191- '%>>(<N>)', '%>>|(<N>)': similar to '%>(<N>)', '%>|(<N>)'
 192  respectively, except that if the next placeholder takes more spaces
 193  than given and there are spaces on its left, use those spaces
 194- '%><(<N>)', '%><|(<N>)': similar to '% <(<N>)', '%<|(<N>)'
 195  respectively, but padding both sides (i.e. the text is centered)
 196
 197NOTE: Some placeholders may depend on other options given to the
 198revision traversal engine. For example, the `%g*` reflog options will
 199insert an empty string unless we are traversing reflog entries (e.g., by
 200`git log -g`). The `%d` and `%D` placeholders will use the "short"
 201decoration format if `--decorate` was not already provided on the command
 202line.
 203
 204If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
 205is inserted immediately before the expansion if and only if the
 206placeholder expands to a non-empty string.
 207
 208If you add a `-` (minus sign) after '%' of a placeholder, line-feeds that
 209immediately precede the expansion are deleted if and only if the
 210placeholder expands to an empty string.
 211
 212If you add a ` ` (space) after '%' of a placeholder, a space
 213is inserted immediately before the expansion if and only if the
 214placeholder expands to a non-empty string.
 215
 216* 'tformat:'
 217+
 218The 'tformat:' format works exactly like 'format:', except that it
 219provides "terminator" semantics instead of "separator" semantics. In
 220other words, each commit has the message terminator character (usually a
 221newline) appended, rather than a separator placed between entries.
 222This means that the final entry of a single-line format will be properly
 223terminated with a new line, just as the "oneline" format does.
 224For example:
 225+
 226---------------------
 227$ git log -2 --pretty=format:%h 4da45bef \
 228  | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 2294da45be
 2307134973 -- NO NEWLINE
 231
 232$ git log -2 --pretty=tformat:%h 4da45bef \
 233  | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 2344da45be
 2357134973
 236---------------------
 237+
 238In addition, any unrecognized string that has a `%` in it is interpreted
 239as if it has `tformat:` in front of it.  For example, these two are
 240equivalent:
 241+
 242---------------------
 243$ git log -2 --pretty=tformat:%h 4da45bef
 244$ git log -2 --pretty=%h 4da45bef
 245---------------------