]>
Commit | Line | Data |
---|---|---|
331b51d2 JN |
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 | |
bae74c9d | 7 | "Merge: " and the hashes of ancestral commits are printed, |
331b51d2 JN |
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 | ||
8028184e WP |
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: | |
331b51d2 JN |
20 | |
21 | * 'oneline' | |
5d1faf87 | 22 | |
bae74c9d | 23 | <hash> <title line> |
5d1faf87 CR |
24 | + |
25 | This is designed to be as compact as possible. | |
26 | ||
331b51d2 | 27 | * 'short' |
5d1faf87 | 28 | |
bae74c9d | 29 | commit <hash> |
5d1faf87 CR |
30 | Author: <author> |
31 | ||
32 | <title line> | |
33 | ||
331b51d2 | 34 | * 'medium' |
5d1faf87 | 35 | |
bae74c9d | 36 | commit <hash> |
5d1faf87 | 37 | Author: <author> |
ec9f0ea3 | 38 | Date: <author date> |
5d1faf87 CR |
39 | |
40 | <title line> | |
41 | ||
42 | <full commit message> | |
43 | ||
331b51d2 | 44 | * 'full' |
5d1faf87 | 45 | |
bae74c9d | 46 | commit <hash> |
5d1faf87 CR |
47 | Author: <author> |
48 | Commit: <committer> | |
49 | ||
50 | <title line> | |
51 | ||
52 | <full commit message> | |
53 | ||
331b51d2 | 54 | * 'fuller' |
5d1faf87 | 55 | |
bae74c9d | 56 | commit <hash> |
ec9f0ea3 | 57 | Author: <author> |
2b2da684 | 58 | AuthorDate: <author date> |
ec9f0ea3 | 59 | Commit: <committer> |
2b2da684 | 60 | CommitDate: <committer date> |
5d1faf87 CR |
61 | |
62 | <title line> | |
63 | ||
64 | <full commit message> | |
65 | ||
1f0fc1db DL |
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 | ||
331b51d2 | 77 | * 'email' |
5d1faf87 | 78 | |
bae74c9d | 79 | From <hash> <date> |
5d1faf87 | 80 | From: <author> |
2b2da684 | 81 | Date: <author date> |
5d1faf87 CR |
82 | Subject: [PATCH] <title line> |
83 | ||
331b51d2 | 84 | <full commit message> |
5d1faf87 | 85 | |
88eaf361 EB |
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 | ||
331b51d2 | 92 | * 'raw' |
5d1faf87 CR |
93 | + |
94 | The 'raw' format shows the entire commit exactly as | |
bae74c9d | 95 | stored in the commit object. Notably, the hashes are |
5d1faf87 CR |
96 | displayed in full, regardless of whether --abbrev or |
97 | --no-abbrev are used, and 'parents' information show the | |
a58088ab | 98 | true parent commits, without taking grafts or history |
92de9217 MM |
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`. | |
7cbcf4d5 | 103 | |
41e4d69f | 104 | * 'format:<string>' |
e52a5de4 | 105 | + |
41e4d69f | 106 | The 'format:<string>' format allows you to specify which information |
e52a5de4 JS |
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'. | |
331b51d2 JN |
110 | + |
111 | E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"' | |
e52a5de4 | 112 | would show something like this: |
331b51d2 JN |
113 | + |
114 | ------- | |
e52a5de4 JS |
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 | ||
c30c43c0 | 118 | ------- |
331b51d2 | 119 | + |
e52a5de4 JS |
120 | The placeholders are: |
121 | ||
42617752 AW |
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 | |
42977bf5 | 139 | `%C(always,...)` will show the colors even when color is |
42617752 AW |
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]) | |
d8b8217c PB |
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]) | |
42617752 AW |
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 | |
0df62117 | 192 | '%as':: author date, short format (`YYYY-MM-DD`) |
42617752 AW |
193 | '%cn':: committer name |
194 | '%cN':: committer name (respecting .mailmap, see | |
195 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
196 | '%ce':: committer email | |
197 | '%cE':: committer email (respecting .mailmap, see | |
198 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
087bf540 MK |
199 | '%cl':: committer email local-part (the part before the '@' sign) |
200 | '%cL':: committer local-part (see '%cl') respecting .mailmap, see | |
d8b8217c | 201 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) |
42617752 AW |
202 | '%cd':: committer date (format respects --date= option) |
203 | '%cD':: committer date, RFC2822 style | |
204 | '%cr':: committer date, relative | |
205 | '%ct':: committer date, UNIX timestamp | |
206 | '%ci':: committer date, ISO 8601-like format | |
207 | '%cI':: committer date, strict ISO 8601 format | |
0df62117 | 208 | '%cs':: committer date, short format (`YYYY-MM-DD`) |
42617752 AW |
209 | '%d':: ref names, like the --decorate option of linkgit:git-log[1] |
210 | '%D':: ref names without the " (", ")" wrapping. | |
42977bf5 JH |
211 | '%S':: ref name given on the command line by which the commit was reached |
212 | (like `git log --source`), only works with `git log` | |
42617752 AW |
213 | '%e':: encoding |
214 | '%s':: subject | |
215 | '%f':: sanitized subject line, suitable for a filename | |
216 | '%b':: body | |
217 | '%B':: raw body (unwrapped subject and body) | |
2aea7a51 | 218 | ifndef::git-rev-list[] |
42617752 | 219 | '%N':: commit notes |
2aea7a51 | 220 | endif::git-rev-list[] |
42617752 AW |
221 | '%GG':: raw verification message from GPG for a signed commit |
222 | '%G?':: show "G" for a good (valid) signature, | |
223 | "B" for a bad signature, | |
224 | "U" for a good signature with unknown validity, | |
225 | "X" for a good signature that has expired, | |
226 | "Y" for a good signature made by an expired key, | |
227 | "R" for a good signature made by a revoked key, | |
228 | "E" if the signature cannot be checked (e.g. missing key) | |
229 | and "N" for no signature | |
230 | '%GS':: show the name of the signer for a signed commit | |
231 | '%GK':: show the key used to sign a signed commit | |
232 | '%GF':: show the fingerprint of the key used to sign a signed commit | |
233 | '%GP':: show the fingerprint of the primary key whose subkey was used | |
234 | to sign a signed commit | |
54887b46 | 235 | '%GT':: show the trust level for the key used to sign a signed commit |
42617752 | 236 | '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2 |
4fd39c76 | 237 | minutes ago}`; the format follows the rules described for the |
42617752 AW |
238 | `-g` option. The portion before the `@` is the refname as |
239 | given on the command line (so `git log -g refs/heads/master` | |
240 | would yield `refs/heads/master@{0}`). | |
241 | '%gd':: shortened reflog selector; same as `%gD`, but the refname | |
242 | portion is shortened for human readability (so | |
243 | `refs/heads/master` becomes just `master`). | |
244 | '%gn':: reflog identity name | |
245 | '%gN':: reflog identity name (respecting .mailmap, see | |
246 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
247 | '%ge':: reflog identity email | |
248 | '%gE':: reflog identity email (respecting .mailmap, see | |
249 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
250 | '%gs':: reflog subject | |
251 | '%(trailers[:options])':: display the trailers of the body as | |
252 | interpreted by | |
253 | linkgit:git-interpret-trailers[1]. The | |
254 | `trailers` string may be followed by a colon | |
255 | and zero or more comma-separated options: | |
250bea0c AW |
256 | ** 'key=<K>': only show trailers with specified key. Matching is done |
257 | case-insensitively and trailing colon is optional. If option is | |
258 | given multiple times trailer lines matching any of the keys are | |
259 | shown. This option automatically enables the `only` option so that | |
260 | non-trailer lines in the trailer block are hidden. If that is not | |
261 | desired it can be disabled with `only=false`. E.g., | |
262 | `%(trailers:key=Reviewed-by)` shows trailer lines with key | |
263 | `Reviewed-by`. | |
4f732e0f AW |
264 | ** 'only[=val]': select whether non-trailer lines from the trailer |
265 | block should be included. The `only` keyword may optionally be | |
266 | followed by an equal sign and one of `true`, `on`, `yes` to omit or | |
267 | `false`, `off`, `no` to show the non-trailer lines. If option is | |
268 | given without value it is enabled. If given multiple times the last | |
269 | value is used. | |
0b691d86 AW |
270 | ** 'separator=<SEP>': specify a separator inserted between trailer |
271 | lines. When this option is not given each trailer line is | |
272 | terminated with a line feed character. The string SEP may contain | |
273 | the literal formatting codes described above. To use comma as | |
274 | separator one must use `%x2C` as it would otherwise be parsed as | |
275 | next option. If separator option is given multiple times only the | |
276 | last one is used. E.g., `%(trailers:key=Ticket,separator=%x2C )` | |
277 | shows all trailer lines whose key is "Ticket" separated by a comma | |
278 | and a space. | |
4f732e0f AW |
279 | ** 'unfold[=val]': make it behave as if interpret-trailer's `--unfold` |
280 | option was given. In same way as to for `only` it can be followed | |
281 | by an equal sign and explicit value. E.g., | |
282 | `%(trailers:only,unfold=true)` unfolds and shows all trailer lines. | |
d9b936db AW |
283 | ** 'valueonly[=val]': skip over the key part of the trailer line and only |
284 | show the value part. Also this optionally allows explicit value. | |
fa5b4f37 | 285 | |
8f8f5476 TR |
286 | NOTE: Some placeholders may depend on other options given to the |
287 | revision traversal engine. For example, the `%g*` reflog options will | |
288 | insert an empty string unless we are traversing reflog entries (e.g., by | |
9271095c HJ |
289 | `git log -g`). The `%d` and `%D` placeholders will use the "short" |
290 | decoration format if `--decorate` was not already provided on the command | |
291 | line. | |
8f8f5476 | 292 | |
6cf378f0 | 293 | If you add a `+` (plus sign) after '%' of a placeholder, a line-feed |
9fa708da JH |
294 | is inserted immediately before the expansion if and only if the |
295 | placeholder expands to a non-empty string. | |
296 | ||
8abc09c0 SG |
297 | If you add a `-` (minus sign) after '%' of a placeholder, all consecutive |
298 | line-feeds immediately preceding the expansion are deleted if and only if the | |
9fa708da JH |
299 | placeholder expands to an empty string. |
300 | ||
7b88176e MG |
301 | If you add a ` ` (space) after '%' of a placeholder, a space |
302 | is inserted immediately before the expansion if and only if the | |
303 | placeholder expands to a non-empty string. | |
304 | ||
fa5b4f37 JK |
305 | * 'tformat:' |
306 | + | |
307 | The 'tformat:' format works exactly like 'format:', except that it | |
308 | provides "terminator" semantics instead of "separator" semantics. In | |
309 | other words, each commit has the message terminator character (usually a | |
310 | newline) appended, rather than a separator placed between entries. | |
311 | This means that the final entry of a single-line format will be properly | |
312 | terminated with a new line, just as the "oneline" format does. | |
313 | For example: | |
314 | + | |
315 | --------------------- | |
316 | $ git log -2 --pretty=format:%h 4da45bef \ | |
317 | | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' | |
318 | 4da45be | |
319 | 7134973 -- NO NEWLINE | |
320 | ||
321 | $ git log -2 --pretty=tformat:%h 4da45bef \ | |
322 | | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' | |
323 | 4da45be | |
324 | 7134973 | |
325 | --------------------- | |
36407548 NS |
326 | + |
327 | In addition, any unrecognized string that has a `%` in it is interpreted | |
328 | as if it has `tformat:` in front of it. For example, these two are | |
329 | equivalent: | |
330 | + | |
331 | --------------------- | |
332 | $ git log -2 --pretty=tformat:%h 4da45bef | |
333 | $ git log -2 --pretty=%h 4da45bef | |
334 | --------------------- |