Autogenerated HTML docs for v1.7.5.1-339-gb602ed
[git/jnareb-git.git] / git-shortlog.html
blobd5129cc02a8c07a685694c6439c5b51c85f98f65
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" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>git-shortlog(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, 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;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#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;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.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;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#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;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-shortlog(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-shortlog -
411 Summarize 'git log' output
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="verseblock">
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>
422 </div>
423 <h2 id="_description">DESCRIPTION</h2>
424 <div class="sectionbody">
425 <div class="paragraph"><p>Summarizes <em>git log</em> output in a format suitable for inclusion
426 in release announcements. Each commit will be grouped by author and
427 the first line of the commit message will be shown.</p></div>
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
430 is not a terminal or there is no current branch, <em>git shortlog</em> will
431 output a summary of the log read from standard input, without
432 reference to the current repository.</p></div>
433 </div>
434 <h2 id="_options">OPTIONS</h2>
435 <div class="sectionbody">
436 <div class="dlist"><dl>
437 <dt class="hdlist1">
439 </dt>
440 <dt class="hdlist1">
441 --help
442 </dt>
443 <dd>
445 Print a short usage message and exit.
446 </p>
447 </dd>
448 <dt class="hdlist1">
450 </dt>
451 <dt class="hdlist1">
452 --numbered
453 </dt>
454 <dd>
456 Sort output according to the number of commits per author instead
457 of author alphabetic order.
458 </p>
459 </dd>
460 <dt class="hdlist1">
462 </dt>
463 <dt class="hdlist1">
464 --summary
465 </dt>
466 <dd>
468 Suppress commit description and provide a commit count summary only.
469 </p>
470 </dd>
471 <dt class="hdlist1">
473 </dt>
474 <dt class="hdlist1">
475 --email
476 </dt>
477 <dd>
479 Show the email address of each author.
480 </p>
481 </dd>
482 <dt class="hdlist1">
483 --format[=&lt;format&gt;]
484 </dt>
485 <dd>
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>
497 <dt class="hdlist1">
498 -w[&lt;width&gt;[,&lt;indent1&gt;[,&lt;indent2&gt;]]]
499 </dt>
500 <dd>
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>
508 </dl></div>
509 </div>
510 <h2 id="_mapping_authors">MAPPING AUTHORS</h2>
511 <div class="sectionbody">
512 <div class="paragraph"><p>The <tt>.mailmap</tt> feature is used to coalesce together commits by the same
513 person in the shortlog, where their name and/or email address was
514 spelled differently.</p></div>
515 <div class="paragraph"><p>If the file <tt>.mailmap</tt> exists at the toplevel of the repository, or at
516 the location pointed to by the mailmap.file configuration option, it
517 is used to map author and committer names and email addresses to
518 canonical real names and email addresses.</p></div>
519 <div class="paragraph"><p>In the simple form, each line in the file consists of the canonical
520 real name of an author, whitespace, and an email address used in the
521 commit (enclosed by <em>&lt;</em> and <em>&gt;</em>) to map to the name. For example:</p></div>
522 <div class="literalblock">
523 <div class="content">
524 <pre><tt>Proper Name &lt;commit@email.xx&gt;</tt></pre>
525 </div></div>
526 <div class="paragraph"><p>The more complex forms are:</p></div>
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>
531 <div class="paragraph"><p>which allows mailmap to replace only the email part of a commit, and:</p></div>
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>
536 <div class="paragraph"><p>which allows mailmap to replace both the name and the email of a
537 commit matching the specified commit email address, and:</p></div>
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>
542 <div class="paragraph"><p>which allows mailmap to replace both the name and the email of a
543 commit matching both the specified commit name and email address.</p></div>
544 <div class="paragraph"><p>Example 1: Your history contains commits by two authors, Jane
545 and Joe, whose names appear in the repository under several forms:</p></div>
546 <div class="listingblock">
547 <div class="content">
548 <pre><tt>Joe Developer &lt;joe@example.com&gt;
549 Joe R. Developer &lt;joe@example.com&gt;
550 Jane Doe &lt;jane@example.com&gt;
551 Jane Doe &lt;jane@laptop.(none)&gt;
552 Jane D. &lt;jane@desktop.(none)&gt;</tt></pre>
553 </div></div>
554 <div class="paragraph"><p>Now suppose that Joe wants his middle name initial used, and Jane
555 prefers her family name fully spelled out. A proper <tt>.mailmap</tt> file
556 would look like:</p></div>
557 <div class="listingblock">
558 <div class="content">
559 <pre><tt>Jane Doe &lt;jane@desktop.(none)&gt;
560 Joe R. Developer &lt;joe@example.com&gt;</tt></pre>
561 </div></div>
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
563 real name of that author is already correct.</p></div>
564 <div class="paragraph"><p>Example 2: Your repository contains commits from the following
565 authors:</p></div>
566 <div class="listingblock">
567 <div class="content">
568 <pre><tt>nick1 &lt;bugs@company.xx&gt;
569 nick2 &lt;bugs@company.xx&gt;
570 nick2 &lt;nick2@company.xx&gt;
571 santa &lt;me@company.xx&gt;
572 claus &lt;me@company.xx&gt;
573 CTO &lt;cto@coompany.xx&gt;</tt></pre>
574 </div></div>
575 <div class="paragraph"><p>Then you might want a <tt>.mailmap</tt> file that looks like:</p></div>
576 <div class="listingblock">
577 <div class="content">
578 <pre><tt>&lt;cto@company.xx&gt; &lt;cto@coompany.xx&gt;
579 Some Dude &lt;some@dude.xx&gt; nick1 &lt;bugs@company.xx&gt;
580 Other Author &lt;other@author.xx&gt; nick2 &lt;bugs@company.xx&gt;
581 Other Author &lt;other@author.xx&gt; &lt;nick2@company.xx&gt;
582 Santa Claus &lt;santa.claus@northpole.xx&gt; &lt;me@company.xx&gt;</tt></pre>
583 </div></div>
584 <div class="paragraph"><p>Use hash <em>#</em> for comments that are either on their own line, or after
585 the email address.</p></div>
586 </div>
587 <h2 id="_git">GIT</h2>
588 <div class="sectionbody">
589 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
590 </div>
591 <div id="footer">
592 <div id="footer-text">
593 Last updated 2011-03-15 23:30:14 UTC
594 </div>
595 </div>
596 </body>
597 </html>