contrib/fast-import/import-zips.py: fix broken error message
[git] / Documentation / pretty-formats.txt
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
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:
20
21 * 'oneline'
22
23           <sha1> <title line>
24 +
25 This is designed to be as compact as possible.
26
27 * 'short'
28
29           commit <sha1>
30           Author: <author>
31
32               <title line>
33
34 * 'medium'
35
36           commit <sha1>
37           Author: <author>
38           Date:   <author date>
39
40               <title line>
41
42               <full commit message>
43
44 * 'full'
45
46           commit <sha1>
47           Author: <author>
48           Commit: <committer>
49
50               <title line>
51
52               <full commit message>
53
54 * 'fuller'
55
56           commit <sha1>
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 * 'email'
67
68           From <sha1> <date>
69           From: <author>
70           Date: <author date>
71           Subject: [PATCH] <title line>
72
73           <full commit message>
74
75 * 'raw'
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.
83
84 * 'format:<string>'
85 +
86 The 'format:<string>' format allows you to specify which information
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'.
90 +
91 E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
92 would show something like this:
93 +
94 -------
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
98 --------
99 +
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
109 - '%aN': author name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
110 - '%ae': author email
111 - '%aE': author email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
112 - '%ad': author date (format respects --date= option)
113 - '%aD': author date, RFC2822 style
114 - '%ar': author date, relative
115 - '%at': author date, UNIX timestamp
116 - '%ai': author date, ISO 8601 format
117 - '%cn': committer name
118 - '%cN': committer name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
119 - '%ce': committer email
120 - '%cE': committer email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
121 - '%cd': committer date
122 - '%cD': committer date, RFC2822 style
123 - '%cr': committer date, relative
124 - '%ct': committer date, UNIX timestamp
125 - '%ci': committer date, ISO 8601 format
126 - '%d': ref names, like the --decorate option of linkgit:git-log[1]
127 - '%e': encoding
128 - '%s': subject
129 - '%f': sanitized subject line, suitable for a filename
130 - '%b': body
131 - '%B': raw body (unwrapped subject and body)
132 - '%N': commit notes
133 - '%GG': raw verification message from GPG for a signed commit
134 - '%G?': show either "G" for Good or "B" for Bad for a signed commit
135 - '%GS': show the name of the signer for a signed commit
136 - '%gD': reflog selector, e.g., `refs/stash@{1}`
137 - '%gd': shortened reflog selector, e.g., `stash@{1}`
138 - '%gn': reflog identity name
139 - '%gN': reflog identity name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
140 - '%ge': reflog identity email
141 - '%gE': reflog identity email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
142 - '%gs': reflog subject
143 - '%Cred': switch color to red
144 - '%Cgreen': switch color to green
145 - '%Cblue': switch color to blue
146 - '%Creset': reset color
147 - '%C(...)': color specification, as described in color.branch.* config option;
148   adding `auto,` at the beginning will emit color only when colors are
149   enabled for log output (by `color.diff`, `color.ui`, or `--color`, and
150   respecting the `auto` settings of the former if we are going to a
151   terminal)
152 - '%m': left, right or boundary mark
153 - '%n': newline
154 - '%%': a raw '%'
155 - '%x00': print a byte from a hex code
156 - '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of
157   linkgit:git-shortlog[1].
158
159 NOTE: Some placeholders may depend on other options given to the
160 revision traversal engine. For example, the `%g*` reflog options will
161 insert an empty string unless we are traversing reflog entries (e.g., by
162 `git log -g`). The `%d` placeholder will use the "short" decoration
163 format if `--decorate` was not already provided on the command line.
164
165 If you add a `+` (plus sign) after '%' of a placeholder, a line-feed
166 is inserted immediately before the expansion if and only if the
167 placeholder expands to a non-empty string.
168
169 If you add a `-` (minus sign) after '%' of a placeholder, line-feeds that
170 immediately precede the expansion are deleted if and only if the
171 placeholder expands to an empty string.
172
173 If you add a ` ` (space) after '%' of a placeholder, a space
174 is inserted immediately before the expansion if and only if the
175 placeholder expands to a non-empty string.
176
177 * 'tformat:'
178 +
179 The 'tformat:' format works exactly like 'format:', except that it
180 provides "terminator" semantics instead of "separator" semantics. In
181 other words, each commit has the message terminator character (usually a
182 newline) appended, rather than a separator placed between entries.
183 This means that the final entry of a single-line format will be properly
184 terminated with a new line, just as the "oneline" format does.
185 For example:
186 +
187 ---------------------
188 $ git log -2 --pretty=format:%h 4da45bef \
189   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
190 4da45be
191 7134973 -- NO NEWLINE
192
193 $ git log -2 --pretty=tformat:%h 4da45bef \
194   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
195 4da45be
196 7134973
197 ---------------------
198 +
199 In addition, any unrecognized string that has a `%` in it is interpreted
200 as if it has `tformat:` in front of it.  For example, these two are
201 equivalent:
202 +
203 ---------------------
204 $ git log -2 --pretty=tformat:%h 4da45bef
205 $ git log -2 --pretty=%h 4da45bef
206 ---------------------