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 hashes 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           <hash> <title-line>
  24 +
  25 This is designed to be as compact as possible.
  26
  27 * 'short'
  28
  29           commit <hash>
  30           Author: <author>
  31
  32               <title-line>
  33
  34 * 'medium'
  35
  36           commit <hash>
  37           Author: <author>
  38           Date:   <author-date>
  39
  40               <title-line>
  41
  42               <full-commit-message>
  43
  44 * 'full'
  45
  46           commit <hash>
  47           Author: <author>
  48           Commit: <committer>
  49
  50               <title-line>
  51
  52               <full-commit-message>
  53
  54 * 'fuller'
  55
  56           commit <hash>
  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 * 'reference'
  67
  68           <abbrev-hash> (<title-line>, <short-author-date>)
  69 +
  70 This format is used to refer to another commit in a commit message and
  71 is the same as `--pretty='format:%C(auto)%h (%s, %ad)'`.  By default,
  72 the date is formatted with `--date=short` unless another `--date` option
  73 is explicitly specified.  As with any `format:` with format
  74 placeholders, its output is not affected by other options like
  75 `--decorate` and `--walk-reflogs`.
  76
  77 * 'email'
  78
  79           From <hash> <date>
  80           From: <author>
  81           Date: <author-date>
  82           Subject: [PATCH] <title-line>
  83
  84           <full-commit-message>
  85
  86 * 'mboxrd'
  87 +
  88 Like 'email', but lines in the commit message starting with "From "
  89 (preceded by zero or more ">") are quoted with ">" so they aren't
  90 confused as starting a new commit.
  91
  92 * 'raw'
  93 +
  94 The 'raw' format shows the entire commit exactly as
  95 stored in the commit object.  Notably, the hashes are
  96 displayed in full, regardless of whether --abbrev or
  97 --no-abbrev are used, and 'parents' information show the
  98 true parent commits, without taking grafts or history
  99 simplification into account. Note that this format affects the way
 100 commits are displayed, but not the way the diff is shown e.g. with
 101 `git log --raw`. To get full object names in a raw diff format,
 102 use `--no-abbrev`.
 103
 104 * 'format:<format-string>'
 105 +
 106 The 'format:<format-string>' format allows you to specify which information
 107 you want to show. It works a little bit like printf format,
 108 with the notable exception that you get a newline with '%n'
 109 instead of '\n'.
 110 +
 111 E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
 112 would show something like this:
 113 +
 114 -------
 115 The author of fe6e0ee was Junio C Hamano, 23 hours ago
 116 The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
 117
 118 -------
 119 +
 120 The placeholders are:
 121
 122 - Placeholders that expand to a single literal character:
 123 '%n':: newline
 124 '%%':: a raw '%'
 125 '%x00':: print a byte from a hex code
 126
 127 - Placeholders that affect formatting of later placeholders:
 128 '%Cred':: switch color to red
 129 '%Cgreen':: switch color to green
 130 '%Cblue':: switch color to blue
 131 '%Creset':: reset color
 132 '%C(...)':: color specification, as described under Values in the
 133             "CONFIGURATION FILE" section of linkgit:git-config[1].  By
 134             default, colors are shown only when enabled for log output
 135             (by `color.diff`, `color.ui`, or `--color`, and respecting
 136             the `auto` settings of the former if we are going to a
 137             terminal). `%C(auto,...)` is accepted as a historical
 138             synonym for the default (e.g., `%C(auto,red)`). Specifying
 139             `%C(always,...)` will show the colors even when color is
 140             not otherwise enabled (though consider just using
 141             `--color=always` to enable color for the whole output,
 142             including this format and anything else git might color).
 143             `auto` alone (i.e. `%C(auto)`) will turn on auto coloring
 144             on the next placeholders until the color is switched
 145             again.
 146 '%m':: left (`<`), right (`>`) or boundary (`-`) mark
 147 '%w([<w>[,<i1>[,<i2>]]])':: switch line wrapping, like the -w option of
 148                             linkgit:git-shortlog[1].
 149 '%<(<N>[,trunc|ltrunc|mtrunc])':: make the next placeholder take at
 150                                   least N columns, padding spaces on
 151                                   the right if necessary.  Optionally
 152                                   truncate at the beginning (ltrunc),
 153                                   the middle (mtrunc) or the end
 154                                   (trunc) if the output is longer than
 155                                   N columns.  Note that truncating
 156                                   only works correctly with N >= 2.
 157 '%<|(<N>)':: make the next placeholder take at least until Nth
 158              columns, padding spaces on the right if necessary
 159 '%>(<N>)', '%>|(<N>)':: similar to '%<(<N>)', '%<|(<N>)' respectively,
 160                         but padding spaces on the left
 161 '%>>(<N>)', '%>>|(<N>)':: similar to '%>(<N>)', '%>|(<N>)'
 162                           respectively, except that if the next
 163                           placeholder takes more spaces than given and
 164                           there are spaces on its left, use those
 165                           spaces
 166 '%><(<N>)', '%><|(<N>)':: similar to '%<(<N>)', '%<|(<N>)'
 167                           respectively, but padding both sides
 168                           (i.e. the text is centered)
 169
 170 - Placeholders that expand to information extracted from the commit:
 171 '%H':: commit hash
 172 '%h':: abbreviated commit hash
 173 '%T':: tree hash
 174 '%t':: abbreviated tree hash
 175 '%P':: parent hashes
 176 '%p':: abbreviated parent hashes
 177 '%an':: author name
 178 '%aN':: author name (respecting .mailmap, see linkgit:git-shortlog[1]
 179         or linkgit:git-blame[1])
 180 '%ae':: author email
 181 '%aE':: author email (respecting .mailmap, see linkgit:git-shortlog[1]
 182         or linkgit:git-blame[1])
 183 '%al':: author email local-part (the part before the '@' sign)
 184 '%aL':: author local-part (see '%al') respecting .mailmap, see
 185         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 186 '%ad':: author date (format respects --date= option)
 187 '%aD':: author date, RFC2822 style
 188 '%ar':: author date, relative
 189 '%at':: author date, UNIX timestamp
 190 '%ai':: author date, ISO 8601-like format
 191 '%aI':: author date, strict ISO 8601 format
 192 '%as':: author date, short format (`YYYY-MM-DD`)
 193 '%ah':: author date, human style (like the `--date=human` option of
 194         linkgit:git-rev-list[1])
 195 '%cn':: committer name
 196 '%cN':: committer name (respecting .mailmap, see
 197         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 198 '%ce':: committer email
 199 '%cE':: committer email (respecting .mailmap, see
 200         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 201 '%cl':: committer email local-part (the part before the '@' sign)
 202 '%cL':: committer local-part (see '%cl') respecting .mailmap, see
 203         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 204 '%cd':: committer date (format respects --date= option)
 205 '%cD':: committer date, RFC2822 style
 206 '%cr':: committer date, relative
 207 '%ct':: committer date, UNIX timestamp
 208 '%ci':: committer date, ISO 8601-like format
 209 '%cI':: committer date, strict ISO 8601 format
 210 '%cs':: committer date, short format (`YYYY-MM-DD`)
 211 '%ch':: committer date, human style (like the `--date=human` option of
 212         linkgit:git-rev-list[1])
 213 '%d':: ref names, like the --decorate option of linkgit:git-log[1]
 214 '%D':: ref names without the " (", ")" wrapping.
 215 '%(describe[:options])':: human-readable name, like
 216                           linkgit:git-describe[1]; empty string for
 217                           undescribable commits.  The `describe` string
 218                           may be followed by a colon and zero or more
 219                           comma-separated options.  Descriptions can be
 220                           inconsistent when tags are added or removed at
 221                           the same time.
 222 +
 223 ** 'tags[=<bool-value>]': Instead of only considering annotated tags,
 224    consider lightweight tags as well.
 225 ** 'abbrev=<number>': Instead of using the default number of hexadecimal digits
 226    (which will vary according to the number of objects in the repository with a
 227    default of 7) of the abbreviated object name, use <number> digits, or as many
 228    digits as needed to form a unique object name.
 229 ** 'match=<pattern>': Only consider tags matching the given
 230    `glob(7)` pattern, excluding the "refs/tags/" prefix.
 231 ** 'exclude=<pattern>': Do not consider tags matching the given
 232    `glob(7)` pattern, excluding the "refs/tags/" prefix.
 233
 234 '%S':: ref name given on the command line by which the commit was reached
 235        (like `git log --source`), only works with `git log`
 236 '%e':: encoding
 237 '%s':: subject
 238 '%f':: sanitized subject line, suitable for a filename
 239 '%b':: body
 240 '%B':: raw body (unwrapped subject and body)
 241 ifndef::git-rev-list[]
 242 '%N':: commit notes
 243 endif::git-rev-list[]
 244 '%GG':: raw verification message from GPG for a signed commit
 245 '%G?':: show "G" for a good (valid) signature,
 246         "B" for a bad signature,
 247         "U" for a good signature with unknown validity,
 248         "X" for a good signature that has expired,
 249         "Y" for a good signature made by an expired key,
 250         "R" for a good signature made by a revoked key,
 251         "E" if the signature cannot be checked (e.g. missing key)
 252         and "N" for no signature
 253 '%GS':: show the name of the signer for a signed commit
 254 '%GK':: show the key used to sign a signed commit
 255 '%GF':: show the fingerprint of the key used to sign a signed commit
 256 '%GP':: show the fingerprint of the primary key whose subkey was used
 257         to sign a signed commit
 258 '%GT':: show the trust level for the key used to sign a signed commit
 259 '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
 260         minutes ago}`; the format follows the rules described for the
 261         `-g` option. The portion before the `@` is the refname as
 262         given on the command line (so `git log -g refs/heads/master`
 263         would yield `refs/heads/master@{0}`).
 264 '%gd':: shortened reflog selector; same as `%gD`, but the refname
 265         portion is shortened for human readability (so
 266         `refs/heads/master` becomes just `master`).
 267 '%gn':: reflog identity name
 268 '%gN':: reflog identity name (respecting .mailmap, see
 269         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 270 '%ge':: reflog identity email
 271 '%gE':: reflog identity email (respecting .mailmap, see
 272         linkgit:git-shortlog[1] or linkgit:git-blame[1])
 273 '%gs':: reflog subject
 274 '%(trailers[:options])':: display the trailers of the body as
 275                           interpreted by
 276                           linkgit:git-interpret-trailers[1]. The
 277                           `trailers` string may be followed by a colon
 278                           and zero or more comma-separated options.
 279                           If any option is provided multiple times the
 280                           last occurrence wins.
 281 +
 282 ** 'key=<key>': only show trailers with specified <key>. Matching is done
 283    case-insensitively and trailing colon is optional. If option is
 284    given multiple times trailer lines matching any of the keys are
 285    shown. This option automatically enables the `only` option so that
 286    non-trailer lines in the trailer block are hidden. If that is not
 287    desired it can be disabled with `only=false`.  E.g.,
 288    `%(trailers:key=Reviewed-by)` shows trailer lines with key
 289    `Reviewed-by`.
 290 ** 'only[=<bool>]': select whether non-trailer lines from the trailer
 291    block should be included.
 292 ** 'separator=<sep>': specify a separator inserted between trailer
 293    lines. When this option is not given each trailer line is
 294    terminated with a line feed character. The string <sep> may contain
 295    the literal formatting codes described above. To use comma as
 296    separator one must use `%x2C` as it would otherwise be parsed as
 297    next option. E.g., `%(trailers:key=Ticket,separator=%x2C )`
 298    shows all trailer lines whose key is "Ticket" separated by a comma
 299    and a space.
 300 ** 'unfold[=<bool>]': make it behave as if interpret-trailer's `--unfold`
 301    option was given. E.g.,
 302    `%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
 303 ** 'keyonly[=<bool>]': only show the key part of the trailer.
 304 ** 'valueonly[=<bool>]': only show the value part of the trailer.
 305 ** 'key_value_separator=<sep>': specify a separator inserted between
 306    trailer lines. When this option is not given each trailer key-value
 307    pair is separated by ": ". Otherwise it shares the same semantics
 308    as 'separator=<sep>' above.
 309
 310 NOTE: Some placeholders may depend on other options given to the
 311 revision traversal engine. For example, the `%g*` reflog options will
 312 insert an empty string unless we are traversing reflog entries (e.g., by
 313 `git log -g`). The `%d` and `%D` placeholders will use the "short"
 314 decoration format if `--decorate` was not already provided on the command
 315 line.
 316
 317 The boolean options accept an optional value `[=<bool-value>]`. The values
 318 `true`, `false`, `on`, `off` etc. are all accepted. See the "boolean"
 319 sub-section in "EXAMPLES" in linkgit:git-config[1]. If a boolean
 320 option is given with no value, it's enabled.
 321
 322 If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
 323 is inserted immediately before the expansion if and only if the
 324 placeholder expands to a non-empty string.
 325
 326 If you add a `-` (minus sign) after '%' of a placeholder, all consecutive
 327 line-feeds immediately preceding the expansion are deleted if and only if the
 328 placeholder expands to an empty string.
 329
 330 If you add a ` ` (space) after '%' of a placeholder, a space
 331 is inserted immediately before the expansion if and only if the
 332 placeholder expands to a non-empty string.
 333
 334 * 'tformat:'
 335 +
 336 The 'tformat:' format works exactly like 'format:', except that it
 337 provides "terminator" semantics instead of "separator" semantics. In
 338 other words, each commit has the message terminator character (usually a
 339 newline) appended, rather than a separator placed between entries.
 340 This means that the final entry of a single-line format will be properly
 341 terminated with a new line, just as the "oneline" format does.
 342 For example:
 343 +
 344 ---------------------
 345 $ git log -2 --pretty=format:%h 4da45bef \
 346   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 347 4da45be
 348 7134973 -- NO NEWLINE
 349
 350 $ git log -2 --pretty=tformat:%h 4da45bef \
 351   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
 352 4da45be
 353 7134973
 354 ---------------------
 355 +
 356 In addition, any unrecognized string that has a `%` in it is interpreted
 357 as if it has `tformat:` in front of it.  For example, these two are
 358 equivalent:
 359 +
 360 ---------------------
 361 $ git log -2 --pretty=tformat:%h 4da45bef
 362 $ git log -2 --pretty=%h 4da45bef
 363 ---------------------