]>
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 | |
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 | |
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 CR |
22 | |
23 | <sha1> <title line> | |
24 | + | |
25 | This is designed to be as compact as possible. | |
26 | ||
331b51d2 | 27 | * 'short' |
5d1faf87 CR |
28 | |
29 | commit <sha1> | |
30 | Author: <author> | |
31 | ||
32 | <title line> | |
33 | ||
331b51d2 | 34 | * 'medium' |
5d1faf87 CR |
35 | |
36 | commit <sha1> | |
37 | Author: <author> | |
ec9f0ea3 | 38 | Date: <author date> |
5d1faf87 CR |
39 | |
40 | <title line> | |
41 | ||
42 | <full commit message> | |
43 | ||
331b51d2 | 44 | * 'full' |
5d1faf87 CR |
45 | |
46 | commit <sha1> | |
47 | Author: <author> | |
48 | Commit: <committer> | |
49 | ||
50 | <title line> | |
51 | ||
52 | <full commit message> | |
53 | ||
331b51d2 | 54 | * 'fuller' |
5d1faf87 CR |
55 | |
56 | commit <sha1> | |
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 | ||
331b51d2 | 66 | * 'email' |
5d1faf87 CR |
67 | |
68 | From <sha1> <date> | |
69 | From: <author> | |
2b2da684 | 70 | Date: <author date> |
5d1faf87 CR |
71 | Subject: [PATCH] <title line> |
72 | ||
331b51d2 | 73 | <full commit message> |
5d1faf87 | 74 | |
331b51d2 | 75 | * 'raw' |
5d1faf87 CR |
76 | + |
77 | The 'raw' format shows the entire commit exactly as | |
d5fa1f1a | 78 | stored in the commit object. Notably, the SHA-1s are |
5d1faf87 CR |
79 | displayed in full, regardless of whether --abbrev or |
80 | --no-abbrev are used, and 'parents' information show the | |
a58088ab | 81 | true parent commits, without taking grafts or history |
5d1faf87 | 82 | simplification into account. |
7cbcf4d5 | 83 | |
41e4d69f | 84 | * 'format:<string>' |
e52a5de4 | 85 | + |
41e4d69f | 86 | The 'format:<string>' format allows you to specify which information |
e52a5de4 JS |
87 | you want to show. It works a little bit like printf format, |
88 | with the notable exception that you get a newline with '%n' | |
89 | instead of '\n'. | |
331b51d2 JN |
90 | + |
91 | E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"' | |
e52a5de4 | 92 | would show something like this: |
331b51d2 JN |
93 | + |
94 | ------- | |
e52a5de4 JS |
95 | The author of fe6e0ee was Junio C Hamano, 23 hours ago |
96 | The title was >>t4119: test autocomputing -p<n> for traditional diff input.<< | |
97 | ||
331b51d2 JN |
98 | -------- |
99 | + | |
e52a5de4 JS |
100 | The placeholders are: |
101 | ||
102 | - '%H': commit hash | |
103 | - '%h': abbreviated commit hash | |
104 | - '%T': tree hash | |
105 | - '%t': abbreviated tree hash | |
106 | - '%P': parent hashes | |
107 | - '%p': abbreviated parent hashes | |
108 | - '%an': author name | |
d2ea4afb NTND |
109 | - '%aN': author name (respecting .mailmap, see linkgit:git-shortlog[1] |
110 | or linkgit:git-blame[1]) | |
e52a5de4 | 111 | - '%ae': author email |
d2ea4afb NTND |
112 | - '%aE': author email (respecting .mailmap, see |
113 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
d36f8679 | 114 | - '%ad': author date (format respects --date= option) |
e52a5de4 JS |
115 | - '%aD': author date, RFC2822 style |
116 | - '%ar': author date, relative | |
117 | - '%at': author date, UNIX timestamp | |
ee8f838e | 118 | - '%ai': author date, ISO 8601 format |
e52a5de4 | 119 | - '%cn': committer name |
d2ea4afb NTND |
120 | - '%cN': committer name (respecting .mailmap, see |
121 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
e52a5de4 | 122 | - '%ce': committer email |
d2ea4afb NTND |
123 | - '%cE': committer email (respecting .mailmap, see |
124 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
e52a5de4 JS |
125 | - '%cd': committer date |
126 | - '%cD': committer date, RFC2822 style | |
127 | - '%cr': committer date, relative | |
128 | - '%ct': committer date, UNIX timestamp | |
ee8f838e | 129 | - '%ci': committer date, ISO 8601 format |
3b3d443f | 130 | - '%d': ref names, like the --decorate option of linkgit:git-log[1] |
e52a5de4 JS |
131 | - '%e': encoding |
132 | - '%s': subject | |
46d164b0 | 133 | - '%f': sanitized subject line, suitable for a filename |
e52a5de4 | 134 | - '%b': body |
1367b12a | 135 | - '%B': raw body (unwrapped subject and body) |
8b208f02 | 136 | - '%N': commit notes |
f2fef7b5 | 137 | - '%GG': raw verification message from GPG for a signed commit |
e290c4b9 SG |
138 | - '%G?': show "G" for a Good signature, "B" for a Bad signature, "U" for a good, |
139 | untrusted signature and "N" for no signature | |
f2fef7b5 | 140 | - '%GS': show the name of the signer for a signed commit |
0174eeaa | 141 | - '%GK': show the key used to sign a signed commit |
6cf378f0 JK |
142 | - '%gD': reflog selector, e.g., `refs/stash@{1}` |
143 | - '%gd': shortened reflog selector, e.g., `stash@{1}` | |
cd1957f5 | 144 | - '%gn': reflog identity name |
d2ea4afb NTND |
145 | - '%gN': reflog identity name (respecting .mailmap, see |
146 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
cd1957f5 | 147 | - '%ge': reflog identity email |
d2ea4afb NTND |
148 | - '%gE': reflog identity email (respecting .mailmap, see |
149 | linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
8f8f5476 | 150 | - '%gs': reflog subject |
e52a5de4 JS |
151 | - '%Cred': switch color to red |
152 | - '%Cgreen': switch color to green | |
153 | - '%Cblue': switch color to blue | |
154 | - '%Creset': reset color | |
30825178 JH |
155 | - '%C(...)': color specification, as described in color.branch.* config option; |
156 | adding `auto,` at the beginning will emit color only when colors are | |
157 | enabled for log output (by `color.diff`, `color.ui`, or `--color`, and | |
158 | respecting the `auto` settings of the former if we are going to a | |
a95f067e NTND |
159 | terminal). `auto` alone (i.e. `%C(auto)`) will turn on auto coloring |
160 | on the next placeholders until the color is switched again. | |
199c45bf | 161 | - '%m': left, right or boundary mark |
e52a5de4 | 162 | - '%n': newline |
0a0416a3 | 163 | - '%%': a raw '%' |
42c8c74c | 164 | - '%x00': print a byte from a hex code |
3288f201 | 165 | - '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of |
8a3c63e0 | 166 | linkgit:git-shortlog[1]. |
a7f01c6b NTND |
167 | - '%<(<N>[,trunc|ltrunc|mtrunc])': make the next placeholder take at |
168 | least N columns, padding spaces on the right if necessary. | |
169 | Optionally truncate at the beginning (ltrunc), the middle (mtrunc) | |
170 | or the end (trunc) if the output is longer than N columns. | |
171 | Note that truncating only works correctly with N >= 2. | |
a5752342 NTND |
172 | - '%<|(<N>)': make the next placeholder take at least until Nth |
173 | columns, padding spaces on the right if necessary | |
174 | - '%>(<N>)', '%>|(<N>)': similar to '%<(<N>)', '%<|(<N>)' | |
175 | respectively, but padding spaces on the left | |
1640632b NTND |
176 | - '%>>(<N>)', '%>>|(<N>)': similar to '%>(<N>)', '%>|(<N>)' |
177 | respectively, except that if the next placeholder takes more spaces | |
178 | than given and there are spaces on its left, use those spaces | |
179 | - '%><(<N>)', '%><|(<N>)': similar to '% <(<N>)', '%<|(<N>)' | |
a5752342 | 180 | respectively, but padding both sides (i.e. the text is centered) |
fa5b4f37 | 181 | |
8f8f5476 TR |
182 | NOTE: Some placeholders may depend on other options given to the |
183 | revision traversal engine. For example, the `%g*` reflog options will | |
184 | insert an empty string unless we are traversing reflog entries (e.g., by | |
185 | `git log -g`). The `%d` placeholder will use the "short" decoration | |
186 | format if `--decorate` was not already provided on the command line. | |
187 | ||
6cf378f0 | 188 | If you add a `+` (plus sign) after '%' of a placeholder, a line-feed |
9fa708da JH |
189 | is inserted immediately before the expansion if and only if the |
190 | placeholder expands to a non-empty string. | |
191 | ||
192 | If you add a `-` (minus sign) after '%' of a placeholder, line-feeds that | |
193 | immediately precede the expansion are deleted if and only if the | |
194 | placeholder expands to an empty string. | |
195 | ||
7b88176e MG |
196 | If you add a ` ` (space) after '%' of a placeholder, a space |
197 | is inserted immediately before the expansion if and only if the | |
198 | placeholder expands to a non-empty string. | |
199 | ||
fa5b4f37 JK |
200 | * 'tformat:' |
201 | + | |
202 | The 'tformat:' format works exactly like 'format:', except that it | |
203 | provides "terminator" semantics instead of "separator" semantics. In | |
204 | other words, each commit has the message terminator character (usually a | |
205 | newline) appended, rather than a separator placed between entries. | |
206 | This means that the final entry of a single-line format will be properly | |
207 | terminated with a new line, just as the "oneline" format does. | |
208 | For example: | |
209 | + | |
210 | --------------------- | |
211 | $ git log -2 --pretty=format:%h 4da45bef \ | |
212 | | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' | |
213 | 4da45be | |
214 | 7134973 -- NO NEWLINE | |
215 | ||
216 | $ git log -2 --pretty=tformat:%h 4da45bef \ | |
217 | | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' | |
218 | 4da45be | |
219 | 7134973 | |
220 | --------------------- | |
36407548 NS |
221 | + |
222 | In addition, any unrecognized string that has a `%` in it is interpreted | |
223 | as if it has `tformat:` in front of it. For example, these two are | |
224 | equivalent: | |
225 | + | |
226 | --------------------- | |
227 | $ git log -2 --pretty=tformat:%h 4da45bef | |
228 | $ git log -2 --pretty=%h 4da45bef | |
229 | --------------------- |