Code

Documentation: git gc packs refs by default now
[git.git] / Documentation / pretty-formats.txt
1 PRETTY FORMATS
2 --------------
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.
14 Here are some additional details for each format:
16 * 'oneline'
18           <sha1> <title line>
19 +
20 This is designed to be as compact as possible.
22 * 'short'
24           commit <sha1>
25           Author: <author>
27               <title line>
29 * 'medium'
31           commit <sha1>
32           Author: <author>
33           Date:   <author date>
35               <title line>
37               <full commit message>
39 * 'full'
41           commit <sha1>
42           Author: <author>
43           Commit: <committer>
45               <title line>
47               <full commit message>
49 * 'fuller'
51           commit <sha1>
52           Author:     <author>
53           AuthorDate: <author date>
54           Commit:     <committer>
55           CommitDate: <committer date>
57                <title line>
59                <full commit message>
61 * 'email'
63           From <sha1> <date>
64           From: <author>
65           Date: <author date>
66           Subject: [PATCH] <title line>
68           <full commit message>
70 * 'raw'
71 +
72 The 'raw' format shows the entire commit exactly as
73 stored in the commit object.  Notably, the SHA1s are
74 displayed in full, regardless of whether --abbrev or
75 --no-abbrev are used, and 'parents' information show the
76 true parent commits, without taking grafts nor history
77 simplification into account.
79 * 'format:'
80 +
81 The 'format:' format allows you to specify which information
82 you want to show. It works a little bit like printf format,
83 with the notable exception that you get a newline with '%n'
84 instead of '\n'.
85 +
86 E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
87 would show something like this:
88 +
89 -------
90 The author of fe6e0ee was Junio C Hamano, 23 hours ago
91 The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
93 --------
94 +
95 The placeholders are:
97 - '%H': commit hash
98 - '%h': abbreviated commit hash
99 - '%T': tree hash
100 - '%t': abbreviated tree hash
101 - '%P': parent hashes
102 - '%p': abbreviated parent hashes
103 - '%an': author name
104 - '%aN': author name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
105 - '%ae': author email
106 - '%aE': author email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
107 - '%ad': author date (format respects --date= option)
108 - '%aD': author date, RFC2822 style
109 - '%ar': author date, relative
110 - '%at': author date, UNIX timestamp
111 - '%ai': author date, ISO 8601 format
112 - '%cn': committer name
113 - '%cN': committer name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
114 - '%ce': committer email
115 - '%cE': committer email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1])
116 - '%cd': committer date
117 - '%cD': committer date, RFC2822 style
118 - '%cr': committer date, relative
119 - '%ct': committer date, UNIX timestamp
120 - '%ci': committer date, ISO 8601 format
121 - '%d': ref names, like the --decorate option of linkgit:git-log[1]
122 - '%e': encoding
123 - '%s': subject
124 - '%f': sanitized subject line, suitable for a filename
125 - '%b': body
126 - '%N': commit notes
127 - '%gD': reflog selector, e.g., `refs/stash@\{1\}`
128 - '%gd': shortened reflog selector, e.g., `stash@\{1\}`
129 - '%gs': reflog subject
130 - '%Cred': switch color to red
131 - '%Cgreen': switch color to green
132 - '%Cblue': switch color to blue
133 - '%Creset': reset color
134 - '%C(...)': color specification, as described in color.branch.* config option
135 - '%m': left, right or boundary mark
136 - '%n': newline
137 - '%x00': print a byte from a hex code
138 - '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of
139   linkgit:git-shortlog[1].
141 NOTE: Some placeholders may depend on other options given to the
142 revision traversal engine. For example, the `%g*` reflog options will
143 insert an empty string unless we are traversing reflog entries (e.g., by
144 `git log -g`). The `%d` placeholder will use the "short" decoration
145 format if `--decorate` was not already provided on the command line.
147 If you add a `{plus}` (plus sign) after '%' of a placeholder, a line-feed
148 is inserted immediately before the expansion if and only if the
149 placeholder expands to a non-empty string.
151 If you add a `-` (minus sign) after '%' of a placeholder, line-feeds that
152 immediately precede the expansion are deleted if and only if the
153 placeholder expands to an empty string.
155 * 'tformat:'
157 The 'tformat:' format works exactly like 'format:', except that it
158 provides "terminator" semantics instead of "separator" semantics. In
159 other words, each commit has the message terminator character (usually a
160 newline) appended, rather than a separator placed between entries.
161 This means that the final entry of a single-line format will be properly
162 terminated with a new line, just as the "oneline" format does.
163 For example:
165 ---------------------
166 $ git log -2 --pretty=format:%h 4da45bef \
167   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
168 4da45be
169 7134973 -- NO NEWLINE
171 $ git log -2 --pretty=tformat:%h 4da45bef \
172   | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/'
173 4da45be
174 7134973
175 ---------------------
177 In addition, any unrecognized string that has a `%` in it is interpreted
178 as if it has `tformat:` in front of it.  For example, these two are
179 equivalent:
181 ---------------------
182 $ git log -2 --pretty=tformat:%h 4da45bef
183 $ git log -2 --pretty=%h 4da45bef
184 ---------------------