Google Git
Sign in
chromium / external / gitster / git-htmldocs / 86d8436428960039361c286795019ee5b9629272 / . / git-shortlog.html
blob: d5129cc02a8c07a685694c6439c5b51c85f98f65 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6<meta name="generator" content="AsciiDoc 8.4.5" />
7<title>git-shortlog(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]30 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]35 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]91}
92span#email {
93}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
127}
128
129div.content { /* Block element content. */
130 padding: 0;
131}
132
133/* Block element titles. */
134div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]135 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
141}
142div.title + * {
143 margin-top: 0;
144}
145
146td div.title:first-child {
147 margin-top: 0.0em;
148}
149div.content div.title:first-child {
150 margin-top: 0.0em;
151}
152div.content + div.title {
153 margin-top: 0.0em;
154}
155
156div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
160}
161
162div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
166}
167
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]168div.quoteblock {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]169 padding-left: 2.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]170 margin-right: 10%;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]171}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]172div.quoteblock > div.attribution {
173 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]174 text-align: right;
175}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]176
177div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
180}
181div.verseblock > div.content {
182 white-space: pre;
183}
184div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
187}
188/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]189div.verseblock + div.attribution {
190 text-align: left;
191}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]192
193div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
200}
201div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
204}
205
206div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
209}
210
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]211div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]212span.image img { border-style: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]213a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]214
215dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
218}
219dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]222 font-style: normal;
223 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]224}
225dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]226 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]227}
228
229ul, ol {
230 list-style-position: outside;
231}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]232ol.arabic {
233 list-style-type: decimal;
234}
235ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]236 list-style-type: lower-alpha;
237}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]238ol.upperalpha {
239 list-style-type: upper-alpha;
240}
241ol.lowerroman {
242 list-style-type: lower-roman;
243}
244ol.upperroman {
245 list-style-type: upper-roman;
246}
247
248div.compact ul, div.compact ol,
249div.compact p, div.compact p,
250div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
253}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]254
255div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]256 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]257}
258thead {
259 font-family: sans-serif;
260 font-weight: bold;
261}
262tfoot {
263 font-weight: bold;
264}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]265td > div.verse {
266 white-space: pre;
267}
268p.table {
269 margin-top: 0;
270}
271/* Because the table frame attribute is overriden by CSS in most browsers. */
272div.tableblock > table[frame="void"] {
273 border-style: none;
274}
275div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
278}
279div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
282}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]283
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]284
285div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
288}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]289div.hdlist tr {
290 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]291}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]292dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
294}
295td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]296 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]297 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]298 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]299 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]300}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]301td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]302 vertical-align: top;
303}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]304div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
307}
308
309.comment {
310 background: yellow;
311}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]312
313@media print {
314 div#footer-badges { display: none; }
315}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]316
317div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
324}
325
326div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
329}
330div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
333}
334div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
337}
338div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
341}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]342/* Overrides for manpage documents */
343h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
348}
349h2 {
350 border-style: none;
351}
352div.sectionbody {
353 margin-left: 5%;
354}
355
356@media print {
357 div#toc { display: none; }
358}
359
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]360/* Workarounds for IE6's broken and incomplete CSS2. */
361
362div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
366}
367div.sidebar-title, div.image-title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]368 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
373}
374
375div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
379}
380
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]381div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
384}
385
386div.verseblock-content {
387 white-space: pre;
388}
389div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]392}
393
394div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
397}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]398
399/* IE6 sets dynamically generated links as visited. */
400div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]401</style>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]402</head>
403<body>
404<div id="header">
405<h1>
406git-shortlog(1) Manual Page
407</h1>
408<h2>NAME</h2>
409<div class="sectionbody">
410<p>git-shortlog -
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]411 Summarize 'git log' output
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]412</p>
413</div>
414</div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]415<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]416<div class="sectionbody">
Junio C Hamanob6bd6ce2007-04-18 23:54:28[diff] [blame]417<div class="verseblock">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]418<div class="verseblock-content">git log --pretty=short | <em>git shortlog</em> [-h] [-n] [-s] [-e] [-w]
419<em>git shortlog</em> [-n|--numbered] [-s|--summary] [-e|--email] [-w[&lt;width&gt;[,&lt;indent1&gt;[,&lt;indent2&gt;]]]] &lt;commit&gt;&#8230;</div>
420<div class="verseblock-attribution">
421</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]422</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]423<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]424<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]425<div class="paragraph"><p>Summarizes <em>git log</em> output in a format suitable for inclusion
Junio C Hamano5f1dfc72006-10-10 04:36:30[diff] [blame]426in release announcements. Each commit will be grouped by author and
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]427the first line of the commit message will be shown.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]428<div class="paragraph"><p>Additionally, "[PATCH]" will be stripped from the commit description.</p></div>
429<div class="paragraph"><p>If no revisions are passed on the command line and either standard input
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]430is not a terminal or there is no current branch, <em>git shortlog</em> will
431output a summary of the log read from standard input, without
432reference to the current repository.</p></div>
Junio C Hamano33db4372006-06-07 19:51:45[diff] [blame]433</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]434<h2 id="_options">OPTIONS</h2>
Junio C Hamano5f1dfc72006-10-10 04:36:30[diff] [blame]435<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]436<div class="dlist"><dl>
437<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]438-h
439</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]440<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]441--help
Junio C Hamano5f1dfc72006-10-10 04:36:30[diff] [blame]442</dt>
443<dd>
444<p>
445 Print a short usage message and exit.
446</p>
447</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]448<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]449-n
450</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]451<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]452--numbered
Junio C Hamano5f1dfc72006-10-10 04:36:30[diff] [blame]453</dt>
454<dd>
455<p>
456 Sort output according to the number of commits per author instead
457 of author alphabetic order.
458</p>
459</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]460<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]461-s
462</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]463<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]464--summary
Junio C Hamano21c0b422006-10-12 19:10:36[diff] [blame]465</dt>
466<dd>
467<p>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]468 Suppress commit description and provide a commit count summary only.
Junio C Hamano21c0b422006-10-12 19:10:36[diff] [blame]469</p>
470</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]471<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]472-e
473</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]474<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]475--email
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]476</dt>
477<dd>
478<p>
479 Show the email address of each author.
480</p>
481</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]482<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]483--format[=&lt;format&gt;]
Junio C Hamanocc7636a2010-05-21 14:57:53[diff] [blame]484</dt>
485<dd>
486<p>
487 Instead of the commit subject, use some other information to
488 describe each commit. <em>&lt;format&gt;</em> can be any string accepted
489 by the <tt>--format</tt> option of <em>git log</em>, such as <em>&#42; [%h] %s</em>.
490 (See the "PRETTY FORMATS" section of <a href="git-log.html">git-log(1)</a>.)
491</p>
492<div class="literalblock">
493<div class="content">
494<pre><tt>Each pretty-printed commit will be rewrapped before it is shown.</tt></pre>
495</div></div>
496</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]497<dt class="hdlist1">
Junio C Hamano1bdd3b02008-04-13 05:33:18[diff] [blame]498-w[&lt;width&gt;[,&lt;indent1&gt;[,&lt;indent2&gt;]]]
499</dt>
500<dd>
501<p>
502 Linewrap the output by wrapping each line at <tt>width</tt>. The first
503 line of each entry is indented by <tt>indent1</tt> spaces, and the second
504 and subsequent lines are indented by <tt>indent2</tt> spaces. <tt>width</tt>,
505 <tt>indent1</tt>, and <tt>indent2</tt> default to 76, 6 and 9 respectively.
506</p>
507</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]508</dl></div>
Junio C Hamano5f1dfc72006-10-10 04:36:30[diff] [blame]509</div>
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]510<h2 id="_mapping_authors">MAPPING AUTHORS</h2>
Junio C Hamano33db4372006-06-07 19:51:45[diff] [blame]511<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]512<div class="paragraph"><p>The <tt>.mailmap</tt> feature is used to coalesce together commits by the same
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]513person in the shortlog, where their name and/or email address was
514spelled differently.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]515<div class="paragraph"><p>If the file <tt>.mailmap</tt> exists at the toplevel of the repository, or at
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]516the location pointed to by the mailmap.file configuration option, it
517is used to map author and committer names and email addresses to
518canonical real names and email addresses.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]519<div class="paragraph"><p>In the simple form, each line in the file consists of the canonical
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]520real name of an author, whitespace, and an email address used in the
Junio C Hamanofd83b8e2009-03-22 08:21:41[diff] [blame]521commit (enclosed by <em>&lt;</em> and <em>&gt;</em>) to map to the name. For example:</p></div>
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]522<div class="literalblock">
523<div class="content">
524<pre><tt>Proper Name &lt;commit@email.xx&gt;</tt></pre>
525</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]526<div class="paragraph"><p>The more complex forms are:</p></div>
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]527<div class="literalblock">
528<div class="content">
529<pre><tt>&lt;proper@email.xx&gt; &lt;commit@email.xx&gt;</tt></pre>
530</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]531<div class="paragraph"><p>which allows mailmap to replace only the email part of a commit, and:</p></div>
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]532<div class="literalblock">
533<div class="content">
534<pre><tt>Proper Name &lt;proper@email.xx&gt; &lt;commit@email.xx&gt;</tt></pre>
535</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]536<div class="paragraph"><p>which allows mailmap to replace both the name and the email of a
Junio C Hamanofd83b8e2009-03-22 08:21:41[diff] [blame]537commit matching the specified commit email address, and:</p></div>
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]538<div class="literalblock">
539<div class="content">
540<pre><tt>Proper Name &lt;proper@email.xx&gt; Commit Name &lt;commit@email.xx&gt;</tt></pre>
541</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]542<div class="paragraph"><p>which allows mailmap to replace both the name and the email of a
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]543commit matching both the specified commit name and email address.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]544<div class="paragraph"><p>Example 1: Your history contains commits by two authors, Jane
Junio C Hamano2fa431b2008-12-28 01:26:23[diff] [blame]545and Joe, whose names appear in the repository under several forms:</p></div>
Junio C Hamano0ec42932007-12-24 19:31:39[diff] [blame]546<div class="listingblock">
Junio C Hamano33db4372006-06-07 19:51:45[diff] [blame]547<div class="content">
Junio C Hamano2fa431b2008-12-28 01:26:23[diff] [blame]548<pre><tt>Joe Developer &lt;joe@example.com&gt;
549Joe R. Developer &lt;joe@example.com&gt;
550Jane Doe &lt;jane@example.com&gt;
551Jane Doe &lt;jane@laptop.(none)&gt;
552Jane D. &lt;jane@desktop.(none)&gt;</tt></pre>
553</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]554<div class="paragraph"><p>Now suppose that Joe wants his middle name initial used, and Jane
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]555prefers her family name fully spelled out. A proper <tt>.mailmap</tt> file
556would look like:</p></div>
Junio C Hamano2fa431b2008-12-28 01:26:23[diff] [blame]557<div class="listingblock">
558<div class="content">
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]559<pre><tt>Jane Doe &lt;jane@desktop.(none)&gt;
Junio C Hamano8b6e23b2009-02-01 06:36:08[diff] [blame]560Joe R. Developer &lt;joe@example.com&gt;</tt></pre>
Junio C Hamano33db4372006-06-07 19:51:45[diff] [blame]561</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]562<div class="paragraph"><p>Note how there is no need for an entry for &lt;<a href="mailto:jane@laptop">jane@laptop</a>.(none)&gt;, because the
Junio C Hamanofd83b8e2009-03-22 08:21:41[diff] [blame]563real name of that author is already correct.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]564<div class="paragraph"><p>Example 2: Your repository contains commits from the following
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]565authors:</p></div>
566<div class="listingblock">
567<div class="content">
568<pre><tt>nick1 &lt;bugs@company.xx&gt;
569nick2 &lt;bugs@company.xx&gt;
570nick2 &lt;nick2@company.xx&gt;
571santa &lt;me@company.xx&gt;
572claus &lt;me@company.xx&gt;
573CTO &lt;cto@coompany.xx&gt;</tt></pre>
574</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]575<div class="paragraph"><p>Then you might want a <tt>.mailmap</tt> file that looks like:</p></div>
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]576<div class="listingblock">
577<div class="content">
578<pre><tt>&lt;cto@company.xx&gt; &lt;cto@coompany.xx&gt;
579Some Dude &lt;some@dude.xx&gt; nick1 &lt;bugs@company.xx&gt;
580Other Author &lt;other@author.xx&gt; nick2 &lt;bugs@company.xx&gt;
581Other Author &lt;other@author.xx&gt; &lt;nick2@company.xx&gt;
582Santa Claus &lt;santa.claus@northpole.xx&gt; &lt;me@company.xx&gt;</tt></pre>
583</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]584<div class="paragraph"><p>Use hash <em>#</em> for comments that are either on their own line, or after
Junio C Hamano8bc410e2009-02-15 10:38:19[diff] [blame]585the email address.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]586</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]587<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]588<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]589<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]590</div>
591<div id="footer">
592<div id="footer-text">
Junio C Hamano5f3d8392011-03-15 23:33:35[diff] [blame]593Last updated 2011-03-15 23:30:14 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]594</div>
595</div>
596</body>
597</html>