]>
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 | |
78 | stored in the commit object. Notably, the SHA1s 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 nor history | |
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 | |
7d48e9e6 | 109 | - '%aN': author name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) |
e52a5de4 | 110 | - '%ae': author email |
7d48e9e6 | 111 | - '%aE': author email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) |
d36f8679 | 112 | - '%ad': author date (format respects --date= option) |
e52a5de4 JS |
113 | - '%aD': author date, RFC2822 style |
114 | - '%ar': author date, relative | |
115 | - '%at': author date, UNIX timestamp | |
ee8f838e | 116 | - '%ai': author date, ISO 8601 format |
e52a5de4 | 117 | - '%cn': committer name |
7d48e9e6 | 118 | - '%cN': committer name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) |
e52a5de4 | 119 | - '%ce': committer email |
7d48e9e6 | 120 | - '%cE': committer email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) |
e52a5de4 JS |
121 | - '%cd': committer date |
122 | - '%cD': committer date, RFC2822 style | |
123 | - '%cr': committer date, relative | |
124 | - '%ct': committer date, UNIX timestamp | |
ee8f838e | 125 | - '%ci': committer date, ISO 8601 format |
3b3d443f | 126 | - '%d': ref names, like the --decorate option of linkgit:git-log[1] |
e52a5de4 JS |
127 | - '%e': encoding |
128 | - '%s': subject | |
46d164b0 | 129 | - '%f': sanitized subject line, suitable for a filename |
e52a5de4 | 130 | - '%b': body |
1367b12a | 131 | - '%B': raw body (unwrapped subject and body) |
8b208f02 | 132 | - '%N': commit notes |
6cf378f0 JK |
133 | - '%gD': reflog selector, e.g., `refs/stash@{1}` |
134 | - '%gd': shortened reflog selector, e.g., `stash@{1}` | |
cd1957f5 JK |
135 | - '%gn': reflog identity name |
136 | - '%gN': reflog identity name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
137 | - '%ge': reflog identity email | |
138 | - '%gE': reflog identity email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) | |
8f8f5476 | 139 | - '%gs': reflog subject |
e52a5de4 JS |
140 | - '%Cred': switch color to red |
141 | - '%Cgreen': switch color to green | |
142 | - '%Cblue': switch color to blue | |
143 | - '%Creset': reset color | |
c002922a | 144 | - '%C(...)': color specification, as described in color.branch.* config option |
199c45bf | 145 | - '%m': left, right or boundary mark |
e52a5de4 | 146 | - '%n': newline |
0a0416a3 | 147 | - '%%': a raw '%' |
42c8c74c | 148 | - '%x00': print a byte from a hex code |
3288f201 | 149 | - '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of |
8a3c63e0 | 150 | linkgit:git-shortlog[1]. |
fa5b4f37 | 151 | |
8f8f5476 TR |
152 | NOTE: Some placeholders may depend on other options given to the |
153 | revision traversal engine. For example, the `%g*` reflog options will | |
154 | insert an empty string unless we are traversing reflog entries (e.g., by | |
155 | `git log -g`). The `%d` placeholder will use the "short" decoration | |
156 | format if `--decorate` was not already provided on the command line. | |
157 | ||
6cf378f0 | 158 | If you add a `+` (plus sign) after '%' of a placeholder, a line-feed |
9fa708da JH |
159 | is inserted immediately before the expansion if and only if the |
160 | placeholder expands to a non-empty string. | |
161 | ||
162 | If you add a `-` (minus sign) after '%' of a placeholder, line-feeds that | |
163 | immediately precede the expansion are deleted if and only if the | |
164 | placeholder expands to an empty string. | |
165 | ||
7b88176e MG |
166 | If you add a ` ` (space) after '%' of a placeholder, a space |
167 | is inserted immediately before the expansion if and only if the | |
168 | placeholder expands to a non-empty string. | |
169 | ||
fa5b4f37 JK |
170 | * 'tformat:' |
171 | + | |
172 | The 'tformat:' format works exactly like 'format:', except that it | |
173 | provides "terminator" semantics instead of "separator" semantics. In | |
174 | other words, each commit has the message terminator character (usually a | |
175 | newline) appended, rather than a separator placed between entries. | |
176 | This means that the final entry of a single-line format will be properly | |
177 | terminated with a new line, just as the "oneline" format does. | |
178 | For example: | |
179 | + | |
180 | --------------------- | |
181 | $ git log -2 --pretty=format:%h 4da45bef \ | |
182 | | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' | |
183 | 4da45be | |
184 | 7134973 -- NO NEWLINE | |
185 | ||
186 | $ git log -2 --pretty=tformat:%h 4da45bef \ | |
187 | | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' | |
188 | 4da45be | |
189 | 7134973 | |
190 | --------------------- | |
36407548 NS |
191 | + |
192 | In addition, any unrecognized string that has a `%` in it is interpreted | |
193 | as if it has `tformat:` in front of it. For example, these two are | |
194 | equivalent: | |
195 | + | |
196 | --------------------- | |
197 | $ git log -2 --pretty=tformat:%h 4da45bef | |
198 | $ git log -2 --pretty=%h 4da45bef | |
199 | --------------------- |