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