blob: 5bb5ef4591bd3d89a34293bfa8beb8347c566aa4 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231<!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 Hamano7bd050f2011-09-22 06:32:226<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano68cf15a2010-11-06 01:01:597<title>git-shortlog(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:238<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:3120a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:2327
28em {
29 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:5930 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:2331}
32
33strong {
34 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:5935 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:2336}
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:3150h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:2351 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:2354 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:3156h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:2362
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:5977ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano1a4e8412005-12-27 08:17:2381pre {
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:3190 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:2391}
92span#email {
93}
Junio C Hamano68cf15a2010-11-06 01:01:5994span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:2395 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:59114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano1a4e8412005-12-27 08:17:23118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22121 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59137 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano1a4e8412005-12-27 08:17:23176}
Junio C Hamano7bd050f2011-09-22 06:32:22177
Junio C Hamano68cf15a2010-11-06 01:01:59178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23180 text-align: right;
181}
Junio C Hamano68cf15a2010-11-06 01:01:59182
Junio C Hamano68cf15a2010-11-06 01:01:59183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano1a4e8412005-12-27 08:17:23194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22205 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23211}
212
Junio C Hamano1a4e8412005-12-27 08:17:23213div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23214span.image img { border-style: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59215a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59224 font-style: normal;
225 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23226}
227dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59228 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano68cf15a2010-11-06 01:01:59234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23238 list-style-type: lower-alpha;
239}
Junio C Hamano68cf15a2010-11-06 01:01:59240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano1a4e8412005-12-27 08:17:23256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31258 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23259}
Junio C Hamano7bd050f2011-09-22 06:32:22260thead, p.table.header {
Junio C Hamano1a4e8412005-12-27 08:17:23261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano68cf15a2010-11-06 01:01:59267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano1a4e8412005-12-27 08:17:23285
Junio C Hamano68cf15a2010-11-06 01:01:59286
287div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano68cf15a2010-11-06 01:01:59291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31293}
Junio C Hamano68cf15a2010-11-06 01:01:59294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23298 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59299 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23300 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59301 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23302}
Junio C Hamano68cf15a2010-11-06 01:01:59303td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23304 vertical-align: top;
305}
Junio C Hamano68cf15a2010-11-06 01:01:59306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano1a4e8412005-12-27 08:17:23314
Junio C Hamano7bd050f2011-09-22 06:32:22315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano1a4e8412005-12-27 08:17:23343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31346
Junio C Hamano7bd050f2011-09-22 06:32:22347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano68cf15a2010-11-06 01:01:59376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano1a4e8412005-12-27 08:17:23394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano68cf15a2010-11-06 01:01:59402 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano68cf15a2010-11-06 01:01:59415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano1a4e8412005-12-27 08:17:23426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22429 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano1a4e8412005-12-27 08:17:23569</head>
570<body>
571<div id="header">
572<h1>
573git-shortlog(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-shortlog -
Junio C Hamano1aa40d22010-01-21 17:46:43578 Summarize 'git log' output
Junio C Hamano1a4e8412005-12-27 08:17:23579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22582<div id="content">
Junio C Hamano68cf15a2010-11-06 01:01:59583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23584<div class="sectionbody">
Junio C Hamanob6bd6ce2007-04-18 23:54:28585<div class="verseblock">
Junio C Hamano68cf15a2010-11-06 01:01:59586<div class="verseblock-content">git log --pretty=short | <em>git shortlog</em> [-h] [-n] [-s] [-e] [-w]
587<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>
588<div class="verseblock-attribution">
589</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23590</div>
Junio C Hamanoba4b9282008-07-06 05:20:31591<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23592<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59593<div class="paragraph"><p>Summarizes <em>git log</em> output in a format suitable for inclusion
Junio C Hamano281fd392012-09-17 23:57:41594in release announcements. Each commit will be grouped by author and title.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59595<div class="paragraph"><p>Additionally, "[PATCH]" will be stripped from the commit description.</p></div>
596<div class="paragraph"><p>If no revisions are passed on the command line and either standard input
Junio C Hamanocc7636a2010-05-21 14:57:53597is not a terminal or there is no current branch, <em>git shortlog</em> will
598output a summary of the log read from standard input, without
599reference to the current repository.</p></div>
Junio C Hamano33db4372006-06-07 19:51:45600</div>
Junio C Hamanoba4b9282008-07-06 05:20:31601<h2 id="_options">OPTIONS</h2>
Junio C Hamano5f1dfc72006-10-10 04:36:30602<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59603<div class="dlist"><dl>
604<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47605-h
606</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59607<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47608--help
Junio C Hamano5f1dfc72006-10-10 04:36:30609</dt>
610<dd>
611<p>
612 Print a short usage message and exit.
613</p>
614</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59615<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47616-n
617</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59618<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47619--numbered
Junio C Hamano5f1dfc72006-10-10 04:36:30620</dt>
621<dd>
622<p>
623 Sort output according to the number of commits per author instead
624 of author alphabetic order.
625</p>
626</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59627<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47628-s
629</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59630<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47631--summary
Junio C Hamano21c0b422006-10-12 19:10:36632</dt>
633<dd>
634<p>
Junio C Hamanof9771f62007-01-17 17:42:30635 Suppress commit description and provide a commit count summary only.
Junio C Hamano21c0b422006-10-12 19:10:36636</p>
637</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59638<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47639-e
640</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59641<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47642--email
Junio C Hamano0c0da5f2007-12-13 02:45:30643</dt>
644<dd>
645<p>
646 Show the email address of each author.
647</p>
648</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59649<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17650--format[=&lt;format&gt;]
Junio C Hamanocc7636a2010-05-21 14:57:53651</dt>
652<dd>
653<p>
654 Instead of the commit subject, use some other information to
655 describe each commit. <em>&lt;format&gt;</em> can be any string accepted
Junio C Hamanob76a6862012-05-02 22:02:46656 by the <tt>--format</tt> option of <em>git log</em>, such as <em>* [%h] %s</em>.
Junio C Hamanoa28a9202012-06-21 07:08:23657 (See the "PRETTY FORMATS" section of <a href="git-log.html">git-log(1)</a>.)
Junio C Hamanocc7636a2010-05-21 14:57:53658</p>
659<div class="literalblock">
660<div class="content">
661<pre><tt>Each pretty-printed commit will be rewrapped before it is shown.</tt></pre>
662</div></div>
663</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59664<dt class="hdlist1">
Junio C Hamano1bdd3b02008-04-13 05:33:18665-w[&lt;width&gt;[,&lt;indent1&gt;[,&lt;indent2&gt;]]]
666</dt>
667<dd>
668<p>
669 Linewrap the output by wrapping each line at <tt>width</tt>. The first
670 line of each entry is indented by <tt>indent1</tt> spaces, and the second
671 and subsequent lines are indented by <tt>indent2</tt> spaces. <tt>width</tt>,
672 <tt>indent1</tt>, and <tt>indent2</tt> default to 76, 6 and 9 respectively.
673</p>
674</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31675</dl></div>
Junio C Hamano5f1dfc72006-10-10 04:36:30676</div>
Junio C Hamano8bc410e2009-02-15 10:38:19677<h2 id="_mapping_authors">MAPPING AUTHORS</h2>
Junio C Hamano33db4372006-06-07 19:51:45678<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59679<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:19680person in the shortlog, where their name and/or email address was
681spelled differently.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59682<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:19683the location pointed to by the mailmap.file configuration option, it
684is used to map author and committer names and email addresses to
685canonical real names and email addresses.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59686<div class="paragraph"><p>In the simple form, each line in the file consists of the canonical
Junio C Hamano8bc410e2009-02-15 10:38:19687real name of an author, whitespace, and an email address used in the
Junio C Hamanofd83b8e2009-03-22 08:21:41688commit (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:19689<div class="literalblock">
690<div class="content">
691<pre><tt>Proper Name &lt;commit@email.xx&gt;</tt></pre>
692</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59693<div class="paragraph"><p>The more complex forms are:</p></div>
Junio C Hamano8bc410e2009-02-15 10:38:19694<div class="literalblock">
695<div class="content">
696<pre><tt>&lt;proper@email.xx&gt; &lt;commit@email.xx&gt;</tt></pre>
697</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59698<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:19699<div class="literalblock">
700<div class="content">
701<pre><tt>Proper Name &lt;proper@email.xx&gt; &lt;commit@email.xx&gt;</tt></pre>
702</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59703<div class="paragraph"><p>which allows mailmap to replace both the name and the email of a
Junio C Hamanofd83b8e2009-03-22 08:21:41704commit matching the specified commit email address, and:</p></div>
Junio C Hamano8bc410e2009-02-15 10:38:19705<div class="literalblock">
706<div class="content">
707<pre><tt>Proper Name &lt;proper@email.xx&gt; Commit Name &lt;commit@email.xx&gt;</tt></pre>
708</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59709<div class="paragraph"><p>which allows mailmap to replace both the name and the email of a
Junio C Hamano8bc410e2009-02-15 10:38:19710commit matching both the specified commit name and email address.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59711<div class="paragraph"><p>Example 1: Your history contains commits by two authors, Jane
Junio C Hamano2fa431b2008-12-28 01:26:23712and Joe, whose names appear in the repository under several forms:</p></div>
Junio C Hamano0ec42932007-12-24 19:31:39713<div class="listingblock">
Junio C Hamano33db4372006-06-07 19:51:45714<div class="content">
Junio C Hamano2fa431b2008-12-28 01:26:23715<pre><tt>Joe Developer &lt;joe@example.com&gt;
716Joe R. Developer &lt;joe@example.com&gt;
717Jane Doe &lt;jane@example.com&gt;
718Jane Doe &lt;jane@laptop.(none)&gt;
719Jane D. &lt;jane@desktop.(none)&gt;</tt></pre>
720</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59721<div class="paragraph"><p>Now suppose that Joe wants his middle name initial used, and Jane
Junio C Hamano8bc410e2009-02-15 10:38:19722prefers her family name fully spelled out. A proper <tt>.mailmap</tt> file
723would look like:</p></div>
Junio C Hamano2fa431b2008-12-28 01:26:23724<div class="listingblock">
725<div class="content">
Junio C Hamano8bc410e2009-02-15 10:38:19726<pre><tt>Jane Doe &lt;jane@desktop.(none)&gt;
Junio C Hamano8b6e23b2009-02-01 06:36:08727Joe R. Developer &lt;joe@example.com&gt;</tt></pre>
Junio C Hamano33db4372006-06-07 19:51:45728</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59729<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:41730real name of that author is already correct.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59731<div class="paragraph"><p>Example 2: Your repository contains commits from the following
Junio C Hamano8bc410e2009-02-15 10:38:19732authors:</p></div>
733<div class="listingblock">
734<div class="content">
735<pre><tt>nick1 &lt;bugs@company.xx&gt;
736nick2 &lt;bugs@company.xx&gt;
737nick2 &lt;nick2@company.xx&gt;
738santa &lt;me@company.xx&gt;
739claus &lt;me@company.xx&gt;
740CTO &lt;cto@coompany.xx&gt;</tt></pre>
741</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59742<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:19743<div class="listingblock">
744<div class="content">
745<pre><tt>&lt;cto@company.xx&gt; &lt;cto@coompany.xx&gt;
746Some Dude &lt;some@dude.xx&gt; nick1 &lt;bugs@company.xx&gt;
747Other Author &lt;other@author.xx&gt; nick2 &lt;bugs@company.xx&gt;
748Other Author &lt;other@author.xx&gt; &lt;nick2@company.xx&gt;
749Santa Claus &lt;santa.claus@northpole.xx&gt; &lt;me@company.xx&gt;</tt></pre>
750</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59751<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:19752the email address.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23753</div>
Junio C Hamanoba4b9282008-07-06 05:20:31754<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23755<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23756<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23757</div>
Junio C Hamano7bd050f2011-09-22 06:32:22758</div>
759<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23760<div id="footer">
761<div id="footer-text">
Junio C Hamano281fd392012-09-17 23:57:41762Last updated 2012-09-17 16:55:59 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23763</div>
764</div>
765</body>
766</html>