factorize revindex code out of builtin-pack-objects.c
[git/mingw.git] / Documentation / pretty-formats.txt
blob0193c3ce58de4f51a164d43e68023fdf5639a920
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>
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: <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: <date & time>
54           Commit: <committer>
55           CommitDate: <date & time>
57                <title line>
59                <full commit message>
61 * 'email'
63           From <sha1> <date>
64           From: <author>
65           Date: <date & time>
66           Subject: [PATCH] <title line>
68           <full commit message>
70 * 'raw'
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:'
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'.
86 E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'
87 would show something like this:
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 --------
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 - '%ae': author email
105 - '%ad': author date
106 - '%aD': author date, RFC2822 style
107 - '%ar': author date, relative
108 - '%at': author date, UNIX timestamp
109 - '%ai': author date, ISO 8601 format
110 - '%cn': committer name
111 - '%ce': committer email
112 - '%cd': committer date
113 - '%cD': committer date, RFC2822 style
114 - '%cr': committer date, relative
115 - '%ct': committer date, UNIX timestamp
116 - '%ci': committer date, ISO 8601 format
117 - '%e': encoding
118 - '%s': subject
119 - '%b': body
120 - '%Cred': switch color to red
121 - '%Cgreen': switch color to green
122 - '%Cblue': switch color to blue
123 - '%Creset': reset color
124 - '%m': left, right or boundary mark
125 - '%n': newline