2007-05-13 23:25:45 +00:00
|
|
|
PRETTY FORMATS
|
|
|
|
--------------
|
|
|
|
|
|
|
|
If the commit is a merge, and if the pretty-format
|
|
|
|
is not 'oneline', 'email' or 'raw', an additional line is
|
|
|
|
inserted before the 'Author:' line. This line begins with
|
|
|
|
"Merge: " and the sha1s of ancestral commits are printed,
|
|
|
|
separated by spaces. Note that the listed commits may not
|
|
|
|
necessarily be the list of the *direct* parent commits if you
|
|
|
|
have limited your view of history: for example, if you are
|
|
|
|
only interested in changes related to a certain directory or
|
|
|
|
file.
|
|
|
|
|
2010-05-02 11:00:44 +00:00
|
|
|
There are several built-in formats, and you can define
|
|
|
|
additional formats by setting a pretty.<name>
|
|
|
|
config option to either another format name, or a
|
|
|
|
'format:' string, as described below (see
|
|
|
|
linkgit:git-config[1]). Here are the details of the
|
|
|
|
built-in formats:
|
2007-05-13 23:25:45 +00:00
|
|
|
|
|
|
|
* 'oneline'
|
2006-11-21 23:49:15 +00:00
|
|
|
|
|
|
|
<sha1> <title line>
|
|
|
|
+
|
|
|
|
This is designed to be as compact as possible.
|
|
|
|
|
2007-05-13 23:25:45 +00:00
|
|
|
* 'short'
|
2006-11-21 23:49:15 +00:00
|
|
|
|
|
|
|
commit <sha1>
|
|
|
|
Author: <author>
|
|
|
|
|
|
|
|
<title line>
|
|
|
|
|
2007-05-13 23:25:45 +00:00
|
|
|
* 'medium'
|
2006-11-21 23:49:15 +00:00
|
|
|
|
|
|
|
commit <sha1>
|
|
|
|
Author: <author>
|
2008-12-19 12:14:52 +00:00
|
|
|
Date: <author date>
|
2006-11-21 23:49:15 +00:00
|
|
|
|
|
|
|
<title line>
|
|
|
|
|
|
|
|
<full commit message>
|
|
|
|
|
2007-05-13 23:25:45 +00:00
|
|
|
* 'full'
|
2006-11-21 23:49:15 +00:00
|
|
|
|
|
|
|
commit <sha1>
|
|
|
|
Author: <author>
|
|
|
|
Commit: <committer>
|
|
|
|
|
|
|
|
<title line>
|
|
|
|
|
|
|
|
<full commit message>
|
|
|
|
|
2007-05-13 23:25:45 +00:00
|
|
|
* 'fuller'
|
2006-11-21 23:49:15 +00:00
|
|
|
|
|
|
|
commit <sha1>
|
2008-12-19 12:14:52 +00:00
|
|
|
Author: <author>
|
2008-07-05 00:00:13 +00:00
|
|
|
AuthorDate: <author date>
|
2008-12-19 12:14:52 +00:00
|
|
|
Commit: <committer>
|
2008-07-05 00:00:13 +00:00
|
|
|
CommitDate: <committer date>
|
2006-11-21 23:49:15 +00:00
|
|
|
|
|
|
|
<title line>
|
|
|
|
|
|
|
|
<full commit message>
|
|
|
|
|
2007-05-13 23:25:45 +00:00
|
|
|
* 'email'
|
2006-11-21 23:49:15 +00:00
|
|
|
|
|
|
|
From <sha1> <date>
|
|
|
|
From: <author>
|
2008-07-05 00:00:13 +00:00
|
|
|
Date: <author date>
|
2006-11-21 23:49:15 +00:00
|
|
|
Subject: [PATCH] <title line>
|
|
|
|
|
2007-05-13 23:25:45 +00:00
|
|
|
<full commit message>
|
2006-11-21 23:49:15 +00:00
|
|
|
|
2007-05-13 23:25:45 +00:00
|
|
|
* 'raw'
|
2006-11-21 23:49:15 +00:00
|
|
|
+
|
|
|
|
The 'raw' format shows the entire commit exactly as
|
2013-04-15 17:49:04 +00:00
|
|
|
stored in the commit object. Notably, the SHA-1s are
|
2006-11-21 23:49:15 +00:00
|
|
|
displayed in full, regardless of whether --abbrev or
|
|
|
|
--no-abbrev are used, and 'parents' information show the
|
2014-03-31 22:11:44 +00:00
|
|
|
true parent commits, without taking grafts or history
|
2015-05-18 17:55:58 +00:00
|
|
|
simplification into account. Note that this format affects the way
|
|
|
|
commits are displayed, but not the way the diff is shown e.g. with
|
|
|
|
`git log --raw`. To get full object names in a raw diff format,
|
|
|
|
use `--no-abbrev`.
|
2006-12-30 19:59:08 +00:00
|
|
|
|
2010-06-01 17:54:46 +00:00
|
|
|
* 'format:<string>'
|
2007-02-23 00:35:03 +00:00
|
|
|
+
|
2010-06-01 17:54:46 +00:00
|
|
|
The 'format:<string>' format allows you to specify which information
|
2007-02-23 00:35:03 +00:00
|
|
|
you want to show. It works a little bit like printf format,
|
|
|
|
with the notable exception that you get a newline with '%n'
|
|
|
|
instead of '\n'.
|
2007-05-13 23:25:45 +00:00
|
|
|
+
|
|
|
|
E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
|
2007-02-23 00:35:03 +00:00
|
|
|
would show something like this:
|
2007-05-13 23:25:45 +00:00
|
|
|
+
|
|
|
|
-------
|
2007-02-23 00:35:03 +00:00
|
|
|
The author of fe6e0ee was Junio C Hamano, 23 hours ago
|
|
|
|
The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
|
|
|
|
|
2014-10-08 20:46:10 +00:00
|
|
|
-------
|
2007-05-13 23:25:45 +00:00
|
|
|
+
|
2007-02-23 00:35:03 +00:00
|
|
|
The placeholders are:
|
|
|
|
|
2018-12-08 16:36:41 +00:00
|
|
|
- Placeholders that expand to a single literal character:
|
|
|
|
'%n':: newline
|
|
|
|
'%%':: a raw '%'
|
|
|
|
'%x00':: print a byte from a hex code
|
|
|
|
|
|
|
|
- Placeholders that affect formatting of later placeholders:
|
|
|
|
'%Cred':: switch color to red
|
|
|
|
'%Cgreen':: switch color to green
|
|
|
|
'%Cblue':: switch color to blue
|
|
|
|
'%Creset':: reset color
|
|
|
|
'%C(...)':: color specification, as described under Values in the
|
|
|
|
"CONFIGURATION FILE" section of linkgit:git-config[1]. By
|
|
|
|
default, colors are shown only when enabled for log output
|
|
|
|
(by `color.diff`, `color.ui`, or `--color`, and respecting
|
|
|
|
the `auto` settings of the former if we are going to a
|
|
|
|
terminal). `%C(auto,...)` is accepted as a historical
|
|
|
|
synonym for the default (e.g., `%C(auto,red)`). Specifying
|
2019-03-07 00:59:52 +00:00
|
|
|
`%C(always,...)` will show the colors even when color is
|
2018-12-08 16:36:41 +00:00
|
|
|
not otherwise enabled (though consider just using
|
|
|
|
`--color=always` to enable color for the whole output,
|
|
|
|
including this format and anything else git might color).
|
|
|
|
`auto` alone (i.e. `%C(auto)`) will turn on auto coloring
|
|
|
|
on the next placeholders until the color is switched
|
|
|
|
again.
|
|
|
|
'%m':: left (`<`), right (`>`) or boundary (`-`) mark
|
|
|
|
'%w([<w>[,<i1>[,<i2>]]])':: switch line wrapping, like the -w option of
|
|
|
|
linkgit:git-shortlog[1].
|
|
|
|
'%<(<N>[,trunc|ltrunc|mtrunc])':: make the next placeholder take at
|
|
|
|
least N columns, padding spaces on
|
|
|
|
the right if necessary. Optionally
|
|
|
|
truncate at the beginning (ltrunc),
|
|
|
|
the middle (mtrunc) or the end
|
|
|
|
(trunc) if the output is longer than
|
|
|
|
N columns. Note that truncating
|
|
|
|
only works correctly with N >= 2.
|
|
|
|
'%<|(<N>)':: make the next placeholder take at least until Nth
|
|
|
|
columns, padding spaces on the right if necessary
|
|
|
|
'%>(<N>)', '%>|(<N>)':: similar to '%<(<N>)', '%<|(<N>)' respectively,
|
|
|
|
but padding spaces on the left
|
|
|
|
'%>>(<N>)', '%>>|(<N>)':: similar to '%>(<N>)', '%>|(<N>)'
|
|
|
|
respectively, except that if the next
|
|
|
|
placeholder takes more spaces than given and
|
|
|
|
there are spaces on its left, use those
|
|
|
|
spaces
|
|
|
|
'%><(<N>)', '%><|(<N>)':: similar to '%<(<N>)', '%<|(<N>)'
|
|
|
|
respectively, but padding both sides
|
|
|
|
(i.e. the text is centered)
|
|
|
|
|
|
|
|
- Placeholders that expand to information extracted from the commit:
|
|
|
|
'%H':: commit hash
|
|
|
|
'%h':: abbreviated commit hash
|
|
|
|
'%T':: tree hash
|
|
|
|
'%t':: abbreviated tree hash
|
|
|
|
'%P':: parent hashes
|
|
|
|
'%p':: abbreviated parent hashes
|
|
|
|
'%an':: author name
|
|
|
|
'%aN':: author name (respecting .mailmap, see linkgit:git-shortlog[1]
|
|
|
|
or linkgit:git-blame[1])
|
|
|
|
'%ae':: author email
|
|
|
|
'%aE':: author email (respecting .mailmap, see linkgit:git-shortlog[1]
|
|
|
|
or linkgit:git-blame[1])
|
|
|
|
'%ad':: author date (format respects --date= option)
|
|
|
|
'%aD':: author date, RFC2822 style
|
|
|
|
'%ar':: author date, relative
|
|
|
|
'%at':: author date, UNIX timestamp
|
|
|
|
'%ai':: author date, ISO 8601-like format
|
|
|
|
'%aI':: author date, strict ISO 8601 format
|
|
|
|
'%cn':: committer name
|
|
|
|
'%cN':: committer name (respecting .mailmap, see
|
|
|
|
linkgit:git-shortlog[1] or linkgit:git-blame[1])
|
|
|
|
'%ce':: committer email
|
|
|
|
'%cE':: committer email (respecting .mailmap, see
|
|
|
|
linkgit:git-shortlog[1] or linkgit:git-blame[1])
|
|
|
|
'%cd':: committer date (format respects --date= option)
|
|
|
|
'%cD':: committer date, RFC2822 style
|
|
|
|
'%cr':: committer date, relative
|
|
|
|
'%ct':: committer date, UNIX timestamp
|
|
|
|
'%ci':: committer date, ISO 8601-like format
|
|
|
|
'%cI':: committer date, strict ISO 8601 format
|
|
|
|
'%d':: ref names, like the --decorate option of linkgit:git-log[1]
|
|
|
|
'%D':: ref names without the " (", ")" wrapping.
|
2019-03-07 00:59:52 +00:00
|
|
|
'%S':: ref name given on the command line by which the commit was reached
|
|
|
|
(like `git log --source`), only works with `git log`
|
2018-12-08 16:36:41 +00:00
|
|
|
'%e':: encoding
|
|
|
|
'%s':: subject
|
|
|
|
'%f':: sanitized subject line, suitable for a filename
|
|
|
|
'%b':: body
|
|
|
|
'%B':: raw body (unwrapped subject and body)
|
2015-08-23 17:56:40 +00:00
|
|
|
ifndef::git-rev-list[]
|
2018-12-08 16:36:41 +00:00
|
|
|
'%N':: commit notes
|
2015-08-23 17:56:40 +00:00
|
|
|
endif::git-rev-list[]
|
2018-12-08 16:36:41 +00:00
|
|
|
'%GG':: raw verification message from GPG for a signed commit
|
|
|
|
'%G?':: show "G" for a good (valid) signature,
|
|
|
|
"B" for a bad signature,
|
|
|
|
"U" for a good signature with unknown validity,
|
|
|
|
"X" for a good signature that has expired,
|
|
|
|
"Y" for a good signature made by an expired key,
|
|
|
|
"R" for a good signature made by a revoked key,
|
|
|
|
"E" if the signature cannot be checked (e.g. missing key)
|
|
|
|
and "N" for no signature
|
|
|
|
'%GS':: show the name of the signer for a signed commit
|
|
|
|
'%GK':: show the key used to sign a signed commit
|
|
|
|
'%GF':: show the fingerprint of the key used to sign a signed commit
|
|
|
|
'%GP':: show the fingerprint of the primary key whose subkey was used
|
|
|
|
to sign a signed commit
|
|
|
|
'%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
|
|
|
|
minutes ago`}; the format follows the rules described for the
|
|
|
|
`-g` option. The portion before the `@` is the refname as
|
|
|
|
given on the command line (so `git log -g refs/heads/master`
|
|
|
|
would yield `refs/heads/master@{0}`).
|
|
|
|
'%gd':: shortened reflog selector; same as `%gD`, but the refname
|
|
|
|
portion is shortened for human readability (so
|
|
|
|
`refs/heads/master` becomes just `master`).
|
|
|
|
'%gn':: reflog identity name
|
|
|
|
'%gN':: reflog identity name (respecting .mailmap, see
|
|
|
|
linkgit:git-shortlog[1] or linkgit:git-blame[1])
|
|
|
|
'%ge':: reflog identity email
|
|
|
|
'%gE':: reflog identity email (respecting .mailmap, see
|
|
|
|
linkgit:git-shortlog[1] or linkgit:git-blame[1])
|
|
|
|
'%gs':: reflog subject
|
|
|
|
'%(trailers[:options])':: display the trailers of the body as
|
|
|
|
interpreted by
|
|
|
|
linkgit:git-interpret-trailers[1]. The
|
|
|
|
`trailers` string may be followed by a colon
|
|
|
|
and zero or more comma-separated options:
|
2019-01-28 21:33:34 +00:00
|
|
|
** 'key=<K>': only show trailers with specified key. Matching is done
|
|
|
|
case-insensitively and trailing colon is optional. If option is
|
|
|
|
given multiple times trailer lines matching any of the keys are
|
|
|
|
shown. This option automatically enables the `only` option so that
|
|
|
|
non-trailer lines in the trailer block are hidden. If that is not
|
|
|
|
desired it can be disabled with `only=false`. E.g.,
|
|
|
|
`%(trailers:key=Reviewed-by)` shows trailer lines with key
|
|
|
|
`Reviewed-by`.
|
2019-01-29 06:49:00 +00:00
|
|
|
** 'only[=val]': select whether non-trailer lines from the trailer
|
|
|
|
block should be included. The `only` keyword may optionally be
|
|
|
|
followed by an equal sign and one of `true`, `on`, `yes` to omit or
|
|
|
|
`false`, `off`, `no` to show the non-trailer lines. If option is
|
|
|
|
given without value it is enabled. If given multiple times the last
|
|
|
|
value is used.
|
2019-01-28 21:33:37 +00:00
|
|
|
** 'separator=<SEP>': specify a separator inserted between trailer
|
|
|
|
lines. When this option is not given each trailer line is
|
|
|
|
terminated with a line feed character. The string SEP may contain
|
|
|
|
the literal formatting codes described above. To use comma as
|
|
|
|
separator one must use `%x2C` as it would otherwise be parsed as
|
|
|
|
next option. If separator option is given multiple times only the
|
|
|
|
last one is used. E.g., `%(trailers:key=Ticket,separator=%x2C )`
|
|
|
|
shows all trailer lines whose key is "Ticket" separated by a comma
|
|
|
|
and a space.
|
2019-01-29 06:49:00 +00:00
|
|
|
** 'unfold[=val]': make it behave as if interpret-trailer's `--unfold`
|
|
|
|
option was given. In same way as to for `only` it can be followed
|
|
|
|
by an equal sign and explicit value. E.g.,
|
|
|
|
`%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
|
2019-01-28 21:33:35 +00:00
|
|
|
** 'valueonly[=val]': skip over the key part of the trailer line and only
|
|
|
|
show the value part. Also this optionally allows explicit value.
|
2008-06-12 06:14:28 +00:00
|
|
|
|
2009-10-19 15:48:10 +00:00
|
|
|
NOTE: Some placeholders may depend on other options given to the
|
|
|
|
revision traversal engine. For example, the `%g*` reflog options will
|
|
|
|
insert an empty string unless we are traversing reflog entries (e.g., by
|
2014-09-18 20:53:53 +00:00
|
|
|
`git log -g`). The `%d` and `%D` placeholders will use the "short"
|
|
|
|
decoration format if `--decorate` was not already provided on the command
|
|
|
|
line.
|
2009-10-19 15:48:10 +00:00
|
|
|
|
docs: stop using asciidoc no-inline-literal
In asciidoc 7, backticks like `foo` produced a typographic
effect, but did not otherwise affect the syntax. In asciidoc
8, backticks introduce an "inline literal" inside which markup
is not interpreted. To keep compatibility with existing
documents, asciidoc 8 has a "no-inline-literal" attribute to
keep the old behavior. We enabled this so that the
documentation could be built on either version.
It has been several years now, and asciidoc 7 is no longer
in wide use. We can now decide whether or not we want
inline literals on their own merits, which are:
1. The source is much easier to read when the literal
contains punctuation. You can use `master~1` instead
of `master{tilde}1`.
2. They are less error-prone. Because of point (1), we
tend to make mistakes and forget the extra layer of
quoting.
This patch removes the no-inline-literal attribute from the
Makefile and converts every use of backticks in the
documentation to an inline literal (they must be cleaned up,
or the example above would literally show "{tilde}" in the
output).
Problematic sites were found by grepping for '`.*[{\\]' and
examined and fixed manually. The results were then verified
by comparing the output of "html2text" on the set of
generated html pages. Doing so revealed that in addition to
making the source more readable, this patch fixes several
formatting bugs:
- HTML rendering used the ellipsis character instead of
literal "..." in code examples (like "git log A...B")
- some code examples used the right-arrow character
instead of '->' because they failed to quote
- api-config.txt did not quote tilde, and the resulting
HTML contained a bogus snippet like:
<tt><sub></tt> foo <tt></sub>bar</tt>
which caused some parsers to choke and omit whole
sections of the page.
- git-commit.txt confused ``foo`` (backticks inside a
literal) with ``foo'' (matched double-quotes)
- mentions of `A U Thor <author@example.com>` used to
erroneously auto-generate a mailto footnote for
author@example.com
- the description of --word-diff=plain incorrectly showed
the output as "[-removed-] and {added}", not "{+added+}".
- using "prime" notation like:
commit `C` and its replacement `C'`
confused asciidoc into thinking that everything between
the first backtick and the final apostrophe were meant
to be inside matched quotes
- asciidoc got confused by the escaping of some of our
asterisks. In particular,
`credential.\*` and `credential.<url>.\*`
properly escaped the asterisk in the first case, but
literally passed through the backslash in the second
case.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-04-26 08:51:57 +00:00
|
|
|
If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
|
2009-10-05 06:43:32 +00:00
|
|
|
is inserted immediately before the expansion if and only if the
|
|
|
|
placeholder expands to a non-empty string.
|
|
|
|
|
2017-06-15 10:36:07 +00:00
|
|
|
If you add a `-` (minus sign) after '%' of a placeholder, all consecutive
|
|
|
|
line-feeds immediately preceding the expansion are deleted if and only if the
|
2009-10-05 06:43:32 +00:00
|
|
|
placeholder expands to an empty string.
|
|
|
|
|
2010-06-14 16:12:29 +00:00
|
|
|
If you add a ` ` (space) after '%' of a placeholder, a space
|
|
|
|
is inserted immediately before the expansion if and only if the
|
|
|
|
placeholder expands to a non-empty string.
|
|
|
|
|
2008-06-12 06:14:28 +00:00
|
|
|
* 'tformat:'
|
|
|
|
+
|
|
|
|
The 'tformat:' format works exactly like 'format:', except that it
|
|
|
|
provides "terminator" semantics instead of "separator" semantics. In
|
|
|
|
other words, each commit has the message terminator character (usually a
|
|
|
|
newline) appended, rather than a separator placed between entries.
|
|
|
|
This means that the final entry of a single-line format will be properly
|
|
|
|
terminated with a new line, just as the "oneline" format does.
|
|
|
|
For example:
|
|
|
|
+
|
|
|
|
---------------------
|
|
|
|
$ git log -2 --pretty=format:%h 4da45bef \
|
|
|
|
| perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
|
|
|
|
4da45be
|
|
|
|
7134973 -- NO NEWLINE
|
|
|
|
|
|
|
|
$ git log -2 --pretty=tformat:%h 4da45bef \
|
|
|
|
| perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
|
|
|
|
4da45be
|
|
|
|
7134973
|
|
|
|
---------------------
|
2009-02-24 09:59:15 +00:00
|
|
|
+
|
|
|
|
In addition, any unrecognized string that has a `%` in it is interpreted
|
|
|
|
as if it has `tformat:` in front of it. For example, these two are
|
|
|
|
equivalent:
|
|
|
|
+
|
|
|
|
---------------------
|
|
|
|
$ git log -2 --pretty=tformat:%h 4da45bef
|
|
|
|
$ git log -2 --pretty=%h 4da45bef
|
|
|
|
---------------------
|