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
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
25 This is designed to be as compact as possible.
58 AuthorDate: <author date>
60 CommitDate: <committer date>
71 Subject: [PATCH] <title line>
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,
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'
94 E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
95 would show something like this:
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.<<
103 The placeholders are:
105 - Placeholders that expand to a single literal character:
108 '%x00':: print a byte from a hex code
110 - Placeholders that affect formatting of later placeholders:
111 '%Cred':: switch color to red
112 '%Cgreen':: switch color to green
113 '%Cblue':: switch color to blue
114 '%Creset':: reset color
115 '%C(...)':: color specification, as described under Values in the
116 "CONFIGURATION FILE" section of linkgit:git-config[1]. By
117 default, colors are shown only when enabled for log output
118 (by `color.diff`, `color.ui`, or `--color`, and respecting
119 the `auto` settings of the former if we are going to a
120 terminal). `%C(auto,...)` is accepted as a historical
121 synonym for the default (e.g., `%C(auto,red)`). Specifying
122 `%C(always,...) will show the colors even when color is
123 not otherwise enabled (though consider just using
124 `--color=always` to enable color for the whole output,
125 including this format and anything else git might color).
126 `auto` alone (i.e. `%C(auto)`) will turn on auto coloring
127 on the next placeholders until the color is switched
129 '%m':: left (`<`), right (`>`) or boundary (`-`) mark
130 '%w([<w>[,<i1>[,<i2>]]])':: switch line wrapping, like the -w option of
131 linkgit:git-shortlog[1].
132 '%<(<N>[,trunc|ltrunc|mtrunc])':: make the next placeholder take at
133 least N columns, padding spaces on
134 the right if necessary. Optionally
135 truncate at the beginning (ltrunc),
136 the middle (mtrunc) or the end
137 (trunc) if the output is longer than
138 N columns. Note that truncating
139 only works correctly with N >= 2.
140 '%<|(<N>)':: make the next placeholder take at least until Nth
141 columns, padding spaces on the right if necessary
142 '%>(<N>)', '%>|(<N>)':: similar to '%<(<N>)', '%<|(<N>)' respectively,
143 but padding spaces on the left
144 '%>>(<N>)', '%>>|(<N>)':: similar to '%>(<N>)', '%>|(<N>)'
145 respectively, except that if the next
146 placeholder takes more spaces than given and
147 there are spaces on its left, use those
149 '%><(<N>)', '%><|(<N>)':: similar to '%<(<N>)', '%<|(<N>)'
150 respectively, but padding both sides
151 (i.e. the text is centered)
153 - Placeholders that expand to information extracted from the commit:
155 '%h':: abbreviated commit hash
157 '%t':: abbreviated tree hash
159 '%p':: abbreviated parent hashes
161 '%aN':: author name (respecting .mailmap, see linkgit:git-shortlog[1]
162 or linkgit:git-blame[1])
164 '%aE':: author email (respecting .mailmap, see linkgit:git-shortlog[1]
165 or linkgit:git-blame[1])
166 '%ad':: author date (format respects --date= option)
167 '%aD':: author date, RFC2822 style
168 '%ar':: author date, relative
169 '%at':: author date, UNIX timestamp
170 '%ai':: author date, ISO 8601-like format
171 '%aI':: author date, strict ISO 8601 format
172 '%cn':: committer name
173 '%cN':: committer name (respecting .mailmap, see
174 linkgit:git-shortlog[1] or linkgit:git-blame[1])
175 '%ce':: committer email
176 '%cE':: committer email (respecting .mailmap, see
177 linkgit:git-shortlog[1] or linkgit:git-blame[1])
178 '%cd':: committer date (format respects --date= option)
179 '%cD':: committer date, RFC2822 style
180 '%cr':: committer date, relative
181 '%ct':: committer date, UNIX timestamp
182 '%ci':: committer date, ISO 8601-like format
183 '%cI':: committer date, strict ISO 8601 format
184 '%d':: ref names, like the --decorate option of linkgit:git-log[1]
185 '%D':: ref names without the " (", ")" wrapping.
188 '%f':: sanitized subject line, suitable for a filename
190 '%B':: raw body (unwrapped subject and body)
191 ifndef::git-rev-list[]
193 endif::git-rev-list[]
194 '%GG':: raw verification message from GPG for a signed commit
195 '%G?':: show "G" for a good (valid) signature,
196 "B" for a bad signature,
197 "U" for a good signature with unknown validity,
198 "X" for a good signature that has expired,
199 "Y" for a good signature made by an expired key,
200 "R" for a good signature made by a revoked key,
201 "E" if the signature cannot be checked (e.g. missing key)
202 and "N" for no signature
203 '%GS':: show the name of the signer for a signed commit
204 '%GK':: show the key used to sign a signed commit
205 '%GF':: show the fingerprint of the key used to sign a signed commit
206 '%GP':: show the fingerprint of the primary key whose subkey was used
207 to sign a signed commit
208 '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
209 minutes ago`}; the format follows the rules described for the
210 `-g` option. The portion before the `@` is the refname as
211 given on the command line (so `git log -g refs/heads/master`
212 would yield `refs/heads/master@{0}`).
213 '%gd':: shortened reflog selector; same as `%gD`, but the refname
214 portion is shortened for human readability (so
215 `refs/heads/master` becomes just `master`).
216 '%gn':: reflog identity name
217 '%gN':: reflog identity name (respecting .mailmap, see
218 linkgit:git-shortlog[1] or linkgit:git-blame[1])
219 '%ge':: reflog identity email
220 '%gE':: reflog identity email (respecting .mailmap, see
221 linkgit:git-shortlog[1] or linkgit:git-blame[1])
222 '%gs':: reflog subject
223 '%(trailers[:options])':: display the trailers of the body as
225 linkgit:git-interpret-trailers[1]. The
226 `trailers` string may be followed by a colon
227 and zero or more comma-separated options:
228 ** 'only[=val]': select whether non-trailer lines from the trailer
229 block should be included. The `only` keyword may optionally be
230 followed by an equal sign and one of `true`, `on`, `yes` to omit or
231 `false`, `off`, `no` to show the non-trailer lines. If option is
232 given without value it is enabled. If given multiple times the last
234 ** 'unfold[=val]': make it behave as if interpret-trailer's `--unfold`
235 option was given. In same way as to for `only` it can be followed
236 by an equal sign and explicit value. E.g.,
237 `%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
239 NOTE: Some placeholders may depend on other options given to the
240 revision traversal engine. For example, the `%g*` reflog options will
241 insert an empty string unless we are traversing reflog entries (e.g., by
242 `git log -g`). The `%d` and `%D` placeholders will use the "short"
243 decoration format if `--decorate` was not already provided on the command
246 If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
247 is inserted immediately before the expansion if and only if the
248 placeholder expands to a non-empty string.
250 If you add a `-` (minus sign) after '%' of a placeholder, all consecutive
251 line-feeds immediately preceding the expansion are deleted if and only if the
252 placeholder expands to an empty string.
254 If you add a ` ` (space) after '%' of a placeholder, a space
255 is inserted immediately before the expansion if and only if the
256 placeholder expands to a non-empty string.
260 The 'tformat:' format works exactly like 'format:', except that it
261 provides "terminator" semantics instead of "separator" semantics. In
262 other words, each commit has the message terminator character (usually a
263 newline) appended, rather than a separator placed between entries.
264 This means that the final entry of a single-line format will be properly
265 terminated with a new line, just as the "oneline" format does.
268 ---------------------
269 $ git log -2 --pretty=format:%h 4da45bef \
270 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
272 7134973 -- NO NEWLINE
274 $ git log -2 --pretty=tformat:%h 4da45bef \
275 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
278 ---------------------
280 In addition, any unrecognized string that has a `%` in it is interpreted
281 as if it has `tformat:` in front of it. For example, these two are
284 ---------------------
285 $ git log -2 --pretty=tformat:%h 4da45bef
286 $ git log -2 --pretty=%h 4da45bef
287 ---------------------