Autogenerated HTML docs for v2.42.0-241-g6bdb5
[git-htmldocs.git] / git-shortlog.html
blob798de1b2dedd5b484b7c8b3b95a99aaf74d589f6
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-shortlog(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-shortlog(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-shortlog -
743 Summarize 'git log' output
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><em>git shortlog</em> [&lt;options&gt;] [&lt;revision-range&gt;] [[--] &lt;path&gt;&#8230;]
753 git log --pretty=short | <em>git shortlog</em> [&lt;options&gt;]</pre>
754 <div class="attribution">
755 </div></div>
756 </div>
757 </div>
758 <div class="sect1">
759 <h2 id="_description">DESCRIPTION</h2>
760 <div class="sectionbody">
761 <div class="paragraph"><p>Summarizes <em>git log</em> output in a format suitable for inclusion
762 in release announcements. Each commit will be grouped by author and title.</p></div>
763 <div class="paragraph"><p>Additionally, "[PATCH]" will be stripped from the commit description.</p></div>
764 <div class="paragraph"><p>If no revisions are passed on the command line and either standard input
765 is not a terminal or there is no current branch, <em>git shortlog</em> will
766 output a summary of the log read from standard input, without
767 reference to the current repository.</p></div>
768 </div>
769 </div>
770 <div class="sect1">
771 <h2 id="_options">OPTIONS</h2>
772 <div class="sectionbody">
773 <div class="dlist"><dl>
774 <dt class="hdlist1">
776 </dt>
777 <dt class="hdlist1">
778 --numbered
779 </dt>
780 <dd>
782 Sort output according to the number of commits per author instead
783 of author alphabetic order.
784 </p>
785 </dd>
786 <dt class="hdlist1">
788 </dt>
789 <dt class="hdlist1">
790 --summary
791 </dt>
792 <dd>
794 Suppress commit description and provide a commit count summary only.
795 </p>
796 </dd>
797 <dt class="hdlist1">
799 </dt>
800 <dt class="hdlist1">
801 --email
802 </dt>
803 <dd>
805 Show the email address of each author.
806 </p>
807 </dd>
808 <dt class="hdlist1">
809 --format[=&lt;format&gt;]
810 </dt>
811 <dd>
813 Instead of the commit subject, use some other information to
814 describe each commit. <em>&lt;format&gt;</em> can be any string accepted
815 by the <code>--format</code> option of <em>git log</em>, such as <em>* [%h] %s</em>.
816 (See the "PRETTY FORMATS" section of <a href="git-log.html">git-log(1)</a>.)
817 </p>
818 <div class="literalblock">
819 <div class="content">
820 <pre><code>Each pretty-printed commit will be rewrapped before it is shown.</code></pre>
821 </div></div>
822 </dd>
823 <dt class="hdlist1">
824 --date=&lt;format&gt;
825 </dt>
826 <dd>
828 Show dates formatted according to the given date string. (See
829 the <code>--date</code> option in the "Commit Formatting" section of
830 <a href="git-log.html">git-log(1)</a>). Useful with <code>--group=format:&lt;format&gt;</code>.
831 </p>
832 </dd>
833 <dt class="hdlist1">
834 --group=&lt;type&gt;
835 </dt>
836 <dd>
838 Group commits based on <code>&lt;type&gt;</code>. If no <code>--group</code> option is
839 specified, the default is <code>author</code>. <code>&lt;type&gt;</code> is one of:
840 </p>
841 <div class="openblock">
842 <div class="content">
843 <div class="ulist"><ul>
844 <li>
846 <code>author</code>, commits are grouped by author
847 </p>
848 </li>
849 <li>
851 <code>committer</code>, commits are grouped by committer (the same as <code>-c</code>)
852 </p>
853 </li>
854 <li>
856 <code>trailer:&lt;field&gt;</code>, the <code>&lt;field&gt;</code> is interpreted as a case-insensitive
857 commit message trailer (see <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>). For
858 example, if your project uses <code>Reviewed-by</code> trailers, you might want
859 to see who has been reviewing with
860 <code>git shortlog -ns --group=trailer:reviewed-by</code>.
861 </p>
862 </li>
863 <li>
865 <code>format:&lt;format&gt;</code>, any string accepted by the <code>--format</code> option of
866 <em>git log</em>. (See the "PRETTY FORMATS" section of
867 <a href="git-log.html">git-log(1)</a>.)
868 </p>
869 <div class="paragraph"><p>Note that commits that do not include the trailer will not be counted.
870 Likewise, commits with multiple trailers (e.g., multiple signoffs) may
871 be counted more than once (but only once per unique trailer value in
872 that commit).</p></div>
873 <div class="paragraph"><p>Shortlog will attempt to parse each trailer value as a <code>name &lt;email&gt;</code>
874 identity. If successful, the mailmap is applied and the email is omitted
875 unless the <code>--email</code> option is specified. If the value cannot be parsed
876 as an identity, it will be taken literally and completely.</p></div>
877 </li>
878 </ul></div>
879 </div></div>
880 <div class="paragraph"><p>If <code>--group</code> is specified multiple times, commits are counted under each
881 value (but again, only once per unique value in that commit). For
882 example, <code>git shortlog --group=author --group=trailer:co-authored-by</code>
883 counts both authors and co-authors.</p></div>
884 </dd>
885 <dt class="hdlist1">
887 </dt>
888 <dt class="hdlist1">
889 --committer
890 </dt>
891 <dd>
893 This is an alias for <code>--group=committer</code>.
894 </p>
895 </dd>
896 <dt class="hdlist1">
897 -w[&lt;width&gt;[,&lt;indent1&gt;[,&lt;indent2&gt;]]]
898 </dt>
899 <dd>
901 Linewrap the output by wrapping each line at <code>width</code>. The first
902 line of each entry is indented by <code>indent1</code> spaces, and the second
903 and subsequent lines are indented by <code>indent2</code> spaces. <code>width</code>,
904 <code>indent1</code>, and <code>indent2</code> default to 76, 6 and 9 respectively.
905 </p>
906 <div class="paragraph"><p>If width is <code>0</code> (zero) then indent the lines of the output without wrapping
907 them.</p></div>
908 </dd>
909 <dt class="hdlist1">
910 &lt;revision-range&gt;
911 </dt>
912 <dd>
914 Show only commits in the specified revision range. When no
915 &lt;revision-range&gt; is specified, it defaults to <code>HEAD</code> (i.e. the
916 whole history leading to the current commit). <code>origin..HEAD</code>
917 specifies all the commits reachable from the current commit
918 (i.e. <code>HEAD</code>), but not from <code>origin</code>. For a complete list of
919 ways to spell &lt;revision-range&gt;, see the "Specifying Ranges"
920 section of <a href="gitrevisions.html">gitrevisions(7)</a>.
921 </p>
922 </dd>
923 <dt class="hdlist1">
924 [--] &lt;path&gt;&#8230;
925 </dt>
926 <dd>
928 Consider only commits that are enough to explain how the files
929 that match the specified paths came to be.
930 </p>
931 <div class="paragraph"><p>Paths may need to be prefixed with <code>--</code> to separate them from
932 options or the revision range, when confusion arises.</p></div>
933 </dd>
934 </dl></div>
935 <div class="sect2">
936 <h3 id="_commit_limiting">Commit Limiting</h3>
937 <div class="paragraph"><p>Besides specifying a range of commits that should be listed using the
938 special notations explained in the description, additional commit
939 limiting may be applied.</p></div>
940 <div class="paragraph"><p>Using more options generally further limits the output (e.g.
941 <code>--since=&lt;date1&gt;</code> limits to commits newer than <code>&lt;date1&gt;</code>, and using it
942 with <code>--grep=&lt;pattern&gt;</code> further limits to commits whose log message
943 has a line that matches <code>&lt;pattern&gt;</code>), unless otherwise noted.</p></div>
944 <div class="paragraph"><p>Note that these are applied before commit
945 ordering and formatting options, such as <code>--reverse</code>.</p></div>
946 <div class="dlist"><dl>
947 <dt class="hdlist1">
948 -&lt;number&gt;
949 </dt>
950 <dt class="hdlist1">
951 -n &lt;number&gt;
952 </dt>
953 <dt class="hdlist1">
954 --max-count=&lt;number&gt;
955 </dt>
956 <dd>
958 Limit the number of commits to output.
959 </p>
960 </dd>
961 <dt class="hdlist1">
962 --skip=&lt;number&gt;
963 </dt>
964 <dd>
966 Skip <em>number</em> commits before starting to show the commit output.
967 </p>
968 </dd>
969 <dt class="hdlist1">
970 --since=&lt;date&gt;
971 </dt>
972 <dt class="hdlist1">
973 --after=&lt;date&gt;
974 </dt>
975 <dd>
977 Show commits more recent than a specific date.
978 </p>
979 </dd>
980 <dt class="hdlist1">
981 --since-as-filter=&lt;date&gt;
982 </dt>
983 <dd>
985 Show all commits more recent than a specific date. This visits
986 all commits in the range, rather than stopping at the first commit which
987 is older than a specific date.
988 </p>
989 </dd>
990 <dt class="hdlist1">
991 --until=&lt;date&gt;
992 </dt>
993 <dt class="hdlist1">
994 --before=&lt;date&gt;
995 </dt>
996 <dd>
998 Show commits older than a specific date.
999 </p>
1000 </dd>
1001 <dt class="hdlist1">
1002 --author=&lt;pattern&gt;
1003 </dt>
1004 <dt class="hdlist1">
1005 --committer=&lt;pattern&gt;
1006 </dt>
1007 <dd>
1009 Limit the commits output to ones with author/committer
1010 header lines that match the specified pattern (regular
1011 expression). With more than one <code>--author=&lt;pattern&gt;</code>,
1012 commits whose author matches any of the given patterns are
1013 chosen (similarly for multiple <code>--committer=&lt;pattern&gt;</code>).
1014 </p>
1015 </dd>
1016 <dt class="hdlist1">
1017 --grep-reflog=&lt;pattern&gt;
1018 </dt>
1019 <dd>
1021 Limit the commits output to ones with reflog entries that
1022 match the specified pattern (regular expression). With
1023 more than one <code>--grep-reflog</code>, commits whose reflog message
1024 matches any of the given patterns are chosen. It is an
1025 error to use this option unless <code>--walk-reflogs</code> is in use.
1026 </p>
1027 </dd>
1028 <dt class="hdlist1">
1029 --grep=&lt;pattern&gt;
1030 </dt>
1031 <dd>
1033 Limit the commits output to ones with log message that
1034 matches the specified pattern (regular expression). With
1035 more than one <code>--grep=&lt;pattern&gt;</code>, commits whose message
1036 matches any of the given patterns are chosen (but see
1037 <code>--all-match</code>).
1038 </p>
1039 <div class="paragraph"><p>When <code>--notes</code> is in effect, the message from the notes is
1040 matched as if it were part of the log message.</p></div>
1041 </dd>
1042 <dt class="hdlist1">
1043 --all-match
1044 </dt>
1045 <dd>
1047 Limit the commits output to ones that match all given <code>--grep</code>,
1048 instead of ones that match at least one.
1049 </p>
1050 </dd>
1051 <dt class="hdlist1">
1052 --invert-grep
1053 </dt>
1054 <dd>
1056 Limit the commits output to ones with log message that do not
1057 match the pattern specified with <code>--grep=&lt;pattern&gt;</code>.
1058 </p>
1059 </dd>
1060 <dt class="hdlist1">
1062 </dt>
1063 <dt class="hdlist1">
1064 --regexp-ignore-case
1065 </dt>
1066 <dd>
1068 Match the regular expression limiting patterns without regard to letter
1069 case.
1070 </p>
1071 </dd>
1072 <dt class="hdlist1">
1073 --basic-regexp
1074 </dt>
1075 <dd>
1077 Consider the limiting patterns to be basic regular expressions;
1078 this is the default.
1079 </p>
1080 </dd>
1081 <dt class="hdlist1">
1083 </dt>
1084 <dt class="hdlist1">
1085 --extended-regexp
1086 </dt>
1087 <dd>
1089 Consider the limiting patterns to be extended regular expressions
1090 instead of the default basic regular expressions.
1091 </p>
1092 </dd>
1093 <dt class="hdlist1">
1095 </dt>
1096 <dt class="hdlist1">
1097 --fixed-strings
1098 </dt>
1099 <dd>
1101 Consider the limiting patterns to be fixed strings (don&#8217;t interpret
1102 pattern as a regular expression).
1103 </p>
1104 </dd>
1105 <dt class="hdlist1">
1107 </dt>
1108 <dt class="hdlist1">
1109 --perl-regexp
1110 </dt>
1111 <dd>
1113 Consider the limiting patterns to be Perl-compatible regular
1114 expressions.
1115 </p>
1116 <div class="paragraph"><p>Support for these types of regular expressions is an optional
1117 compile-time dependency. If Git wasn&#8217;t compiled with support for them
1118 providing this option will cause it to die.</p></div>
1119 </dd>
1120 <dt class="hdlist1">
1121 --remove-empty
1122 </dt>
1123 <dd>
1125 Stop when a given path disappears from the tree.
1126 </p>
1127 </dd>
1128 <dt class="hdlist1">
1129 --merges
1130 </dt>
1131 <dd>
1133 Print only merge commits. This is exactly the same as <code>--min-parents=2</code>.
1134 </p>
1135 </dd>
1136 <dt class="hdlist1">
1137 --no-merges
1138 </dt>
1139 <dd>
1141 Do not print commits with more than one parent. This is
1142 exactly the same as <code>--max-parents=1</code>.
1143 </p>
1144 </dd>
1145 <dt class="hdlist1">
1146 --min-parents=&lt;number&gt;
1147 </dt>
1148 <dt class="hdlist1">
1149 --max-parents=&lt;number&gt;
1150 </dt>
1151 <dt class="hdlist1">
1152 --no-min-parents
1153 </dt>
1154 <dt class="hdlist1">
1155 --no-max-parents
1156 </dt>
1157 <dd>
1159 Show only commits which have at least (or at most) that many parent
1160 commits. In particular, <code>--max-parents=1</code> is the same as <code>--no-merges</code>,
1161 <code>--min-parents=2</code> is the same as <code>--merges</code>. <code>--max-parents=0</code>
1162 gives all root commits and <code>--min-parents=3</code> all octopus merges.
1163 </p>
1164 <div class="paragraph"><p><code>--no-min-parents</code> and <code>--no-max-parents</code> reset these limits (to no limit)
1165 again. Equivalent forms are <code>--min-parents=0</code> (any commit has 0 or more
1166 parents) and <code>--max-parents=-1</code> (negative numbers denote no upper limit).</p></div>
1167 </dd>
1168 <dt class="hdlist1">
1169 --first-parent
1170 </dt>
1171 <dd>
1173 When finding commits to include, follow only the first
1174 parent commit upon seeing a merge commit. This option
1175 can give a better overview when viewing the evolution of
1176 a particular topic branch, because merges into a topic
1177 branch tend to be only about adjusting to updated upstream
1178 from time to time, and this option allows you to ignore
1179 the individual commits brought in to your history by such
1180 a merge.
1181 </p>
1182 </dd>
1183 <dt class="hdlist1">
1184 --exclude-first-parent-only
1185 </dt>
1186 <dd>
1188 When finding commits to exclude (with a <em>&#94;</em>), follow only
1189 the first parent commit upon seeing a merge commit.
1190 This can be used to find the set of changes in a topic branch
1191 from the point where it diverged from the remote branch, given
1192 that arbitrary merges can be valid topic branch changes.
1193 </p>
1194 </dd>
1195 <dt class="hdlist1">
1196 --not
1197 </dt>
1198 <dd>
1200 Reverses the meaning of the <em>&#94;</em> prefix (or lack thereof)
1201 for all following revision specifiers, up to the next <code>--not</code>.
1202 </p>
1203 </dd>
1204 <dt class="hdlist1">
1205 --all
1206 </dt>
1207 <dd>
1209 Pretend as if all the refs in <code>refs/</code>, along with <code>HEAD</code>, are
1210 listed on the command line as <em>&lt;commit&gt;</em>.
1211 </p>
1212 </dd>
1213 <dt class="hdlist1">
1214 --branches[=&lt;pattern&gt;]
1215 </dt>
1216 <dd>
1218 Pretend as if all the refs in <code>refs/heads</code> are listed
1219 on the command line as <em>&lt;commit&gt;</em>. If <em>&lt;pattern&gt;</em> is given, limit
1220 branches to ones matching given shell glob. If pattern lacks <em>?</em>,
1221 <em>&#42;</em>, or <em>[</em>, <em>/&#42;</em> at the end is implied.
1222 </p>
1223 </dd>
1224 <dt class="hdlist1">
1225 --tags[=&lt;pattern&gt;]
1226 </dt>
1227 <dd>
1229 Pretend as if all the refs in <code>refs/tags</code> are listed
1230 on the command line as <em>&lt;commit&gt;</em>. If <em>&lt;pattern&gt;</em> is given, limit
1231 tags to ones matching given shell glob. If pattern lacks <em>?</em>, <em>&#42;</em>,
1232 or <em>[</em>, <em>/&#42;</em> at the end is implied.
1233 </p>
1234 </dd>
1235 <dt class="hdlist1">
1236 --remotes[=&lt;pattern&gt;]
1237 </dt>
1238 <dd>
1240 Pretend as if all the refs in <code>refs/remotes</code> are listed
1241 on the command line as <em>&lt;commit&gt;</em>. If <em>&lt;pattern&gt;</em> is given, limit
1242 remote-tracking branches to ones matching given shell glob.
1243 If pattern lacks <em>?</em>, <em>&#42;</em>, or <em>[</em>, <em>/&#42;</em> at the end is implied.
1244 </p>
1245 </dd>
1246 <dt class="hdlist1">
1247 --glob=&lt;glob-pattern&gt;
1248 </dt>
1249 <dd>
1251 Pretend as if all the refs matching shell glob <em>&lt;glob-pattern&gt;</em>
1252 are listed on the command line as <em>&lt;commit&gt;</em>. Leading <em>refs/</em>,
1253 is automatically prepended if missing. If pattern lacks <em>?</em>, <em>&#42;</em>,
1254 or <em>[</em>, <em>/&#42;</em> at the end is implied.
1255 </p>
1256 </dd>
1257 <dt class="hdlist1">
1258 --exclude=&lt;glob-pattern&gt;
1259 </dt>
1260 <dd>
1262 Do not include refs matching <em>&lt;glob-pattern&gt;</em> that the next <code>--all</code>,
1263 <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or <code>--glob</code> would otherwise
1264 consider. Repetitions of this option accumulate exclusion patterns
1265 up to the next <code>--all</code>, <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or
1266 <code>--glob</code> option (other options or arguments do not clear
1267 accumulated patterns).
1268 </p>
1269 <div class="paragraph"><p>The patterns given should not begin with <code>refs/heads</code>, <code>refs/tags</code>, or
1270 <code>refs/remotes</code> when applied to <code>--branches</code>, <code>--tags</code>, or <code>--remotes</code>,
1271 respectively, and they must begin with <code>refs/</code> when applied to <code>--glob</code>
1272 or <code>--all</code>. If a trailing <em>/&#42;</em> is intended, it must be given
1273 explicitly.</p></div>
1274 </dd>
1275 <dt class="hdlist1">
1276 --exclude-hidden=[fetch|receive|uploadpack]
1277 </dt>
1278 <dd>
1280 Do not include refs that would be hidden by <code>git-fetch</code>,
1281 <code>git-receive-pack</code> or <code>git-upload-pack</code> by consulting the appropriate
1282 <code>fetch.hideRefs</code>, <code>receive.hideRefs</code> or <code>uploadpack.hideRefs</code>
1283 configuration along with <code>transfer.hideRefs</code> (see
1284 <a href="git-config.html">git-config(1)</a>). This option affects the next pseudo-ref option
1285 <code>--all</code> or <code>--glob</code> and is cleared after processing them.
1286 </p>
1287 </dd>
1288 <dt class="hdlist1">
1289 --reflog
1290 </dt>
1291 <dd>
1293 Pretend as if all objects mentioned by reflogs are listed on the
1294 command line as <code>&lt;commit&gt;</code>.
1295 </p>
1296 </dd>
1297 <dt class="hdlist1">
1298 --alternate-refs
1299 </dt>
1300 <dd>
1302 Pretend as if all objects mentioned as ref tips of alternate
1303 repositories were listed on the command line. An alternate
1304 repository is any repository whose object directory is specified
1305 in <code>objects/info/alternates</code>. The set of included objects may
1306 be modified by <code>core.alternateRefsCommand</code>, etc. See
1307 <a href="git-config.html">git-config(1)</a>.
1308 </p>
1309 </dd>
1310 <dt class="hdlist1">
1311 --single-worktree
1312 </dt>
1313 <dd>
1315 By default, all working trees will be examined by the
1316 following options when there are more than one (see
1317 <a href="git-worktree.html">git-worktree(1)</a>): <code>--all</code>, <code>--reflog</code> and
1318 <code>--indexed-objects</code>.
1319 This option forces them to examine the current working tree
1320 only.
1321 </p>
1322 </dd>
1323 <dt class="hdlist1">
1324 --ignore-missing
1325 </dt>
1326 <dd>
1328 Upon seeing an invalid object name in the input, pretend as if
1329 the bad input was not given.
1330 </p>
1331 </dd>
1332 <dt class="hdlist1">
1333 --bisect
1334 </dt>
1335 <dd>
1337 Pretend as if the bad bisection ref <code>refs/bisect/bad</code>
1338 was listed and as if it was followed by <code>--not</code> and the good
1339 bisection refs <code>refs/bisect/good-*</code> on the command
1340 line.
1341 </p>
1342 </dd>
1343 <dt class="hdlist1">
1344 --stdin
1345 </dt>
1346 <dd>
1348 In addition to getting arguments from the command line, read
1349 them from standard input as well. This accepts commits and
1350 pseudo-options like <code>--all</code> and <code>--glob=</code>. When a <code>--</code> separator
1351 is seen, the following input is treated as paths and used to
1352 limit the result.
1353 </p>
1354 </dd>
1355 <dt class="hdlist1">
1356 --cherry-mark
1357 </dt>
1358 <dd>
1360 Like <code>--cherry-pick</code> (see below) but mark equivalent commits
1361 with <code>=</code> rather than omitting them, and inequivalent ones with <code>+</code>.
1362 </p>
1363 </dd>
1364 <dt class="hdlist1">
1365 --cherry-pick
1366 </dt>
1367 <dd>
1369 Omit any commit that introduces the same change as
1370 another commit on the &#8220;other side&#8221; when the set of
1371 commits are limited with symmetric difference.
1372 </p>
1373 <div class="paragraph"><p>For example, if you have two branches, <code>A</code> and <code>B</code>, a usual way
1374 to list all commits on only one side of them is with
1375 <code>--left-right</code> (see the example below in the description of
1376 the <code>--left-right</code> option). However, it shows the commits that were
1377 cherry-picked from the other branch (for example, &#8220;3rd on b&#8221; may be
1378 cherry-picked from branch A). With this option, such pairs of commits are
1379 excluded from the output.</p></div>
1380 </dd>
1381 <dt class="hdlist1">
1382 --left-only
1383 </dt>
1384 <dt class="hdlist1">
1385 --right-only
1386 </dt>
1387 <dd>
1389 List only commits on the respective side of a symmetric difference,
1390 i.e. only those which would be marked <code>&lt;</code> resp. <code>&gt;</code> by
1391 <code>--left-right</code>.
1392 </p>
1393 <div class="paragraph"><p>For example, <code>--cherry-pick --right-only A...B</code> omits those
1394 commits from <code>B</code> which are in <code>A</code> or are patch-equivalent to a commit in
1395 <code>A</code>. In other words, this lists the <code>+</code> commits from <code>git cherry A B</code>.
1396 More precisely, <code>--cherry-pick --right-only --no-merges</code> gives the exact
1397 list.</p></div>
1398 </dd>
1399 <dt class="hdlist1">
1400 --cherry
1401 </dt>
1402 <dd>
1404 A synonym for <code>--right-only --cherry-mark --no-merges</code>; useful to
1405 limit the output to the commits on our side and mark those that
1406 have been applied to the other side of a forked history with
1407 <code>git log --cherry upstream...mybranch</code>, similar to
1408 <code>git cherry upstream mybranch</code>.
1409 </p>
1410 </dd>
1411 <dt class="hdlist1">
1413 </dt>
1414 <dt class="hdlist1">
1415 --walk-reflogs
1416 </dt>
1417 <dd>
1419 Instead of walking the commit ancestry chain, walk
1420 reflog entries from the most recent one to older ones.
1421 When this option is used you cannot specify commits to
1422 exclude (that is, <em>&#94;commit</em>, <em>commit1..commit2</em>,
1423 and <em>commit1...commit2</em> notations cannot be used).
1424 </p>
1425 <div class="paragraph"><p>With <code>--pretty</code> format other than <code>oneline</code> and <code>reference</code> (for obvious reasons),
1426 this causes the output to have two extra lines of information
1427 taken from the reflog. The reflog designator in the output may be shown
1428 as <code>ref@{Nth}</code> (where <code>Nth</code> is the reverse-chronological index in the
1429 reflog) or as <code>ref@{timestamp}</code> (with the timestamp for that entry),
1430 depending on a few rules:</p></div>
1431 <div class="openblock">
1432 <div class="content">
1433 <div class="olist arabic"><ol class="arabic">
1434 <li>
1436 If the starting point is specified as <code>ref@{Nth}</code>, show the index
1437 format.
1438 </p>
1439 </li>
1440 <li>
1442 If the starting point was specified as <code>ref@{now}</code>, show the
1443 timestamp format.
1444 </p>
1445 </li>
1446 <li>
1448 If neither was used, but <code>--date</code> was given on the command line, show
1449 the timestamp in the format requested by <code>--date</code>.
1450 </p>
1451 </li>
1452 <li>
1454 Otherwise, show the index format.
1455 </p>
1456 </li>
1457 </ol></div>
1458 </div></div>
1459 <div class="paragraph"><p>Under <code>--pretty=oneline</code>, the commit message is
1460 prefixed with this information on the same line.
1461 This option cannot be combined with <code>--reverse</code>.
1462 See also <a href="git-reflog.html">git-reflog(1)</a>.</p></div>
1463 <div class="paragraph"><p>Under <code>--pretty=reference</code>, this information will not be shown at all.</p></div>
1464 </dd>
1465 <dt class="hdlist1">
1466 --merge
1467 </dt>
1468 <dd>
1470 After a failed merge, show refs that touch files having a
1471 conflict and don&#8217;t exist on all heads to merge.
1472 </p>
1473 </dd>
1474 <dt class="hdlist1">
1475 --boundary
1476 </dt>
1477 <dd>
1479 Output excluded boundary commits. Boundary commits are
1480 prefixed with <code>-</code>.
1481 </p>
1482 </dd>
1483 </dl></div>
1484 </div>
1485 <div class="sect2">
1486 <h3 id="_history_simplification">History Simplification</h3>
1487 <div class="paragraph"><p>Sometimes you are only interested in parts of the history, for example the
1488 commits modifying a particular &lt;path&gt;. But there are two parts of
1489 <em>History Simplification</em>, one part is selecting the commits and the other
1490 is how to do it, as there are various strategies to simplify the history.</p></div>
1491 <div class="paragraph"><p>The following options select the commits to be shown:</p></div>
1492 <div class="dlist"><dl>
1493 <dt class="hdlist1">
1494 &lt;paths&gt;
1495 </dt>
1496 <dd>
1498 Commits modifying the given &lt;paths&gt; are selected.
1499 </p>
1500 </dd>
1501 <dt class="hdlist1">
1502 --simplify-by-decoration
1503 </dt>
1504 <dd>
1506 Commits that are referred by some branch or tag are selected.
1507 </p>
1508 </dd>
1509 </dl></div>
1510 <div class="paragraph"><p>Note that extra commits can be shown to give a meaningful history.</p></div>
1511 <div class="paragraph"><p>The following options affect the way the simplification is performed:</p></div>
1512 <div class="dlist"><dl>
1513 <dt class="hdlist1">
1514 Default mode
1515 </dt>
1516 <dd>
1518 Simplifies the history to the simplest history explaining the
1519 final state of the tree. Simplest because it prunes some side
1520 branches if the end result is the same (i.e. merging branches
1521 with the same content)
1522 </p>
1523 </dd>
1524 <dt class="hdlist1">
1525 --show-pulls
1526 </dt>
1527 <dd>
1529 Include all commits from the default mode, but also any merge
1530 commits that are not TREESAME to the first parent but are
1531 TREESAME to a later parent. This mode is helpful for showing
1532 the merge commits that "first introduced" a change to a branch.
1533 </p>
1534 </dd>
1535 <dt class="hdlist1">
1536 --full-history
1537 </dt>
1538 <dd>
1540 Same as the default mode, but does not prune some history.
1541 </p>
1542 </dd>
1543 <dt class="hdlist1">
1544 --dense
1545 </dt>
1546 <dd>
1548 Only the selected commits are shown, plus some to have a
1549 meaningful history.
1550 </p>
1551 </dd>
1552 <dt class="hdlist1">
1553 --sparse
1554 </dt>
1555 <dd>
1557 All commits in the simplified history are shown.
1558 </p>
1559 </dd>
1560 <dt class="hdlist1">
1561 --simplify-merges
1562 </dt>
1563 <dd>
1565 Additional option to <code>--full-history</code> to remove some needless
1566 merges from the resulting history, as there are no selected
1567 commits contributing to this merge.
1568 </p>
1569 </dd>
1570 <dt class="hdlist1">
1571 --ancestry-path[=&lt;commit&gt;]
1572 </dt>
1573 <dd>
1575 When given a range of commits to display (e.g. <em>commit1..commit2</em>
1576 or <em>commit2 &#94;commit1</em>), only display commits in that range
1577 that are ancestors of &lt;commit&gt;, descendants of &lt;commit&gt;, or
1578 &lt;commit&gt; itself. If no commit is specified, use <em>commit1</em> (the
1579 excluded part of the range) as &lt;commit&gt;. Can be passed multiple
1580 times; if so, a commit is included if it is any of the commits
1581 given or if it is an ancestor or descendant of one of them.
1582 </p>
1583 </dd>
1584 </dl></div>
1585 <div class="paragraph"><p>A more detailed explanation follows.</p></div>
1586 <div class="paragraph"><p>Suppose you specified <code>foo</code> as the &lt;paths&gt;. We shall call commits
1587 that modify <code>foo</code> !TREESAME, and the rest TREESAME. (In a diff
1588 filtered for <code>foo</code>, they look different and equal, respectively.)</p></div>
1589 <div class="paragraph"><p>In the following, we will always refer to the same example history to
1590 illustrate the differences between simplification settings. We assume
1591 that you are filtering for a file <code>foo</code> in this commit graph:</p></div>
1592 <div class="listingblock">
1593 <div class="content">
1594 <pre><code> .-A---M---N---O---P---Q
1595 / / / / / /
1596 I B C D E Y
1597 \ / / / / /
1598 `-------------' X</code></pre>
1599 </div></div>
1600 <div class="paragraph"><p>The horizontal line of history A---Q is taken to be the first parent of
1601 each merge. The commits are:</p></div>
1602 <div class="ulist"><ul>
1603 <li>
1605 <code>I</code> is the initial commit, in which <code>foo</code> exists with contents
1606 &#8220;asdf&#8221;, and a file <code>quux</code> exists with contents &#8220;quux&#8221;. Initial
1607 commits are compared to an empty tree, so <code>I</code> is !TREESAME.
1608 </p>
1609 </li>
1610 <li>
1612 In <code>A</code>, <code>foo</code> contains just &#8220;foo&#8221;.
1613 </p>
1614 </li>
1615 <li>
1617 <code>B</code> contains the same change as <code>A</code>. Its merge <code>M</code> is trivial and
1618 hence TREESAME to all parents.
1619 </p>
1620 </li>
1621 <li>
1623 <code>C</code> does not change <code>foo</code>, but its merge <code>N</code> changes it to &#8220;foobar&#8221;,
1624 so it is not TREESAME to any parent.
1625 </p>
1626 </li>
1627 <li>
1629 <code>D</code> sets <code>foo</code> to &#8220;baz&#8221;. Its merge <code>O</code> combines the strings from
1630 <code>N</code> and <code>D</code> to &#8220;foobarbaz&#8221;; i.e., it is not TREESAME to any parent.
1631 </p>
1632 </li>
1633 <li>
1635 <code>E</code> changes <code>quux</code> to &#8220;xyzzy&#8221;, and its merge <code>P</code> combines the
1636 strings to &#8220;quux xyzzy&#8221;. <code>P</code> is TREESAME to <code>O</code>, but not to <code>E</code>.
1637 </p>
1638 </li>
1639 <li>
1641 <code>X</code> is an independent root commit that added a new file <code>side</code>, and <code>Y</code>
1642 modified it. <code>Y</code> is TREESAME to <code>X</code>. Its merge <code>Q</code> added <code>side</code> to <code>P</code>, and
1643 <code>Q</code> is TREESAME to <code>P</code>, but not to <code>Y</code>.
1644 </p>
1645 </li>
1646 </ul></div>
1647 <div class="paragraph"><p><code>rev-list</code> walks backwards through history, including or excluding
1648 commits based on whether <code>--full-history</code> and/or parent rewriting
1649 (via <code>--parents</code> or <code>--children</code>) are used. The following settings
1650 are available.</p></div>
1651 <div class="dlist"><dl>
1652 <dt class="hdlist1">
1653 Default mode
1654 </dt>
1655 <dd>
1657 Commits are included if they are not TREESAME to any parent
1658 (though this can be changed, see <code>--sparse</code> below). If the
1659 commit was a merge, and it was TREESAME to one parent, follow
1660 only that parent. (Even if there are several TREESAME
1661 parents, follow only one of them.) Otherwise, follow all
1662 parents.
1663 </p>
1664 <div class="paragraph"><p>This results in:</p></div>
1665 <div class="listingblock">
1666 <div class="content">
1667 <pre><code> .-A---N---O
1668 / / /
1669 I---------D</code></pre>
1670 </div></div>
1671 <div class="paragraph"><p>Note how the rule to only follow the TREESAME parent, if one is
1672 available, removed <code>B</code> from consideration entirely. <code>C</code> was
1673 considered via <code>N</code>, but is TREESAME. Root commits are compared to an
1674 empty tree, so <code>I</code> is !TREESAME.</p></div>
1675 <div class="paragraph"><p>Parent/child relations are only visible with <code>--parents</code>, but that does
1676 not affect the commits selected in default mode, so we have shown the
1677 parent lines.</p></div>
1678 </dd>
1679 <dt class="hdlist1">
1680 --full-history without parent rewriting
1681 </dt>
1682 <dd>
1684 This mode differs from the default in one point: always follow
1685 all parents of a merge, even if it is TREESAME to one of them.
1686 Even if more than one side of the merge has commits that are
1687 included, this does not imply that the merge itself is! In
1688 the example, we get
1689 </p>
1690 <div class="listingblock">
1691 <div class="content">
1692 <pre><code> I A B N D O P Q</code></pre>
1693 </div></div>
1694 <div class="paragraph"><p><code>M</code> was excluded because it is TREESAME to both parents. <code>E</code>,
1695 <code>C</code> and <code>B</code> were all walked, but only <code>B</code> was !TREESAME, so the others
1696 do not appear.</p></div>
1697 <div class="paragraph"><p>Note that without parent rewriting, it is not really possible to talk
1698 about the parent/child relationships between the commits, so we show
1699 them disconnected.</p></div>
1700 </dd>
1701 <dt class="hdlist1">
1702 --full-history with parent rewriting
1703 </dt>
1704 <dd>
1706 Ordinary commits are only included if they are !TREESAME
1707 (though this can be changed, see <code>--sparse</code> below).
1708 </p>
1709 <div class="paragraph"><p>Merges are always included. However, their parent list is rewritten:
1710 Along each parent, prune away commits that are not included
1711 themselves. This results in</p></div>
1712 <div class="listingblock">
1713 <div class="content">
1714 <pre><code> .-A---M---N---O---P---Q
1715 / / / / /
1716 I B / D /
1717 \ / / / /
1718 `-------------'</code></pre>
1719 </div></div>
1720 <div class="paragraph"><p>Compare to <code>--full-history</code> without rewriting above. Note that <code>E</code>
1721 was pruned away because it is TREESAME, but the parent list of P was
1722 rewritten to contain <code>E</code>'s parent <code>I</code>. The same happened for <code>C</code> and
1723 <code>N</code>, and <code>X</code>, <code>Y</code> and <code>Q</code>.</p></div>
1724 </dd>
1725 </dl></div>
1726 <div class="paragraph"><p>In addition to the above settings, you can change whether TREESAME
1727 affects inclusion:</p></div>
1728 <div class="dlist"><dl>
1729 <dt class="hdlist1">
1730 --dense
1731 </dt>
1732 <dd>
1734 Commits that are walked are included if they are not TREESAME
1735 to any parent.
1736 </p>
1737 </dd>
1738 <dt class="hdlist1">
1739 --sparse
1740 </dt>
1741 <dd>
1743 All commits that are walked are included.
1744 </p>
1745 <div class="paragraph"><p>Note that without <code>--full-history</code>, this still simplifies merges: if
1746 one of the parents is TREESAME, we follow only that one, so the other
1747 sides of the merge are never walked.</p></div>
1748 </dd>
1749 <dt class="hdlist1">
1750 --simplify-merges
1751 </dt>
1752 <dd>
1754 First, build a history graph in the same way that
1755 <code>--full-history</code> with parent rewriting does (see above).
1756 </p>
1757 <div class="paragraph"><p>Then simplify each commit <code>C</code> to its replacement <code>C'</code> in the final
1758 history according to the following rules:</p></div>
1759 <div class="openblock">
1760 <div class="content">
1761 <div class="ulist"><ul>
1762 <li>
1764 Set <code>C'</code> to <code>C</code>.
1765 </p>
1766 </li>
1767 <li>
1769 Replace each parent <code>P</code> of <code>C'</code> with its simplification <code>P'</code>. In
1770 the process, drop parents that are ancestors of other parents or that are
1771 root commits TREESAME to an empty tree, and remove duplicates, but take care
1772 to never drop all parents that we are TREESAME to.
1773 </p>
1774 </li>
1775 <li>
1777 If after this parent rewriting, <code>C'</code> is a root or merge commit (has
1778 zero or &gt;1 parents), a boundary commit, or !TREESAME, it remains.
1779 Otherwise, it is replaced with its only parent.
1780 </p>
1781 </li>
1782 </ul></div>
1783 </div></div>
1784 <div class="paragraph"><p>The effect of this is best shown by way of comparing to
1785 <code>--full-history</code> with parent rewriting. The example turns into:</p></div>
1786 <div class="listingblock">
1787 <div class="content">
1788 <pre><code> .-A---M---N---O
1789 / / /
1790 I B D
1791 \ / /
1792 `---------'</code></pre>
1793 </div></div>
1794 <div class="paragraph"><p>Note the major differences in <code>N</code>, <code>P</code>, and <code>Q</code> over <code>--full-history</code>:</p></div>
1795 <div class="openblock">
1796 <div class="content">
1797 <div class="ulist"><ul>
1798 <li>
1800 <code>N</code>'s parent list had <code>I</code> removed, because it is an ancestor of the
1801 other parent <code>M</code>. Still, <code>N</code> remained because it is !TREESAME.
1802 </p>
1803 </li>
1804 <li>
1806 <code>P</code>'s parent list similarly had <code>I</code> removed. <code>P</code> was then
1807 removed completely, because it had one parent and is TREESAME.
1808 </p>
1809 </li>
1810 <li>
1812 <code>Q</code>'s parent list had <code>Y</code> simplified to <code>X</code>. <code>X</code> was then removed, because it
1813 was a TREESAME root. <code>Q</code> was then removed completely, because it had one
1814 parent and is TREESAME.
1815 </p>
1816 </li>
1817 </ul></div>
1818 </div></div>
1819 </dd>
1820 </dl></div>
1821 <div class="paragraph"><p>There is another simplification mode available:</p></div>
1822 <div class="dlist"><dl>
1823 <dt class="hdlist1">
1824 --ancestry-path[=&lt;commit&gt;]
1825 </dt>
1826 <dd>
1828 Limit the displayed commits to those which are an ancestor of
1829 &lt;commit&gt;, or which are a descendant of &lt;commit&gt;, or are &lt;commit&gt;
1830 itself.
1831 </p>
1832 <div class="paragraph"><p>As an example use case, consider the following commit history:</p></div>
1833 <div class="listingblock">
1834 <div class="content">
1835 <pre><code> D---E-------F
1836 / \ \
1837 B---C---G---H---I---J
1839 A-------K---------------L--M</code></pre>
1840 </div></div>
1841 <div class="paragraph"><p>A regular <em>D..M</em> computes the set of commits that are ancestors of <code>M</code>,
1842 but excludes the ones that are ancestors of <code>D</code>. This is useful to see
1843 what happened to the history leading to <code>M</code> since <code>D</code>, in the sense
1844 that &#8220;what does <code>M</code> have that did not exist in <code>D</code>&#8221;. The result in this
1845 example would be all the commits, except <code>A</code> and <code>B</code> (and <code>D</code> itself,
1846 of course).</p></div>
1847 <div class="paragraph"><p>When we want to find out what commits in <code>M</code> are contaminated with the
1848 bug introduced by <code>D</code> and need fixing, however, we might want to view
1849 only the subset of <em>D..M</em> that are actually descendants of <code>D</code>, i.e.
1850 excluding <code>C</code> and <code>K</code>. This is exactly what the <code>--ancestry-path</code>
1851 option does. Applied to the <em>D..M</em> range, it results in:</p></div>
1852 <div class="listingblock">
1853 <div class="content">
1854 <pre><code> E-------F
1856 G---H---I---J
1858 L--M</code></pre>
1859 </div></div>
1860 <div class="paragraph"><p>We can also use <code>--ancestry-path=D</code> instead of <code>--ancestry-path</code> which
1861 means the same thing when applied to the <em>D..M</em> range but is just more
1862 explicit.</p></div>
1863 <div class="paragraph"><p>If we instead are interested in a given topic within this range, and all
1864 commits affected by that topic, we may only want to view the subset of
1865 <code>D..M</code> which contain that topic in their ancestry path. So, using
1866 <code>--ancestry-path=H D..M</code> for example would result in:</p></div>
1867 <div class="listingblock">
1868 <div class="content">
1869 <pre><code> E
1871 G---H---I---J
1873 L--M</code></pre>
1874 </div></div>
1875 <div class="paragraph"><p>Whereas <code>--ancestry-path=K D..M</code> would result in</p></div>
1876 <div class="listingblock">
1877 <div class="content">
1878 <pre><code> K---------------L--M</code></pre>
1879 </div></div>
1880 </dd>
1881 </dl></div>
1882 <div class="paragraph"><p>Before discussing another option, <code>--show-pulls</code>, we need to
1883 create a new example history.</p></div>
1884 <div class="paragraph"><p>A common problem users face when looking at simplified history is that a
1885 commit they know changed a file somehow does not appear in the file&#8217;s
1886 simplified history. Let&#8217;s demonstrate a new example and show how options
1887 such as <code>--full-history</code> and <code>--simplify-merges</code> works in that case:</p></div>
1888 <div class="listingblock">
1889 <div class="content">
1890 <pre><code> .-A---M-----C--N---O---P
1891 / / \ \ \/ / /
1892 I B \ R-'`-Z' /
1893 \ / \/ /
1894 \ / /\ /
1895 `---X--' `---Y--'</code></pre>
1896 </div></div>
1897 <div class="paragraph"><p>For this example, suppose <code>I</code> created <code>file.txt</code> which was modified by
1898 <code>A</code>, <code>B</code>, and <code>X</code> in different ways. The single-parent commits <code>C</code>, <code>Z</code>,
1899 and <code>Y</code> do not change <code>file.txt</code>. The merge commit <code>M</code> was created by
1900 resolving the merge conflict to include both changes from <code>A</code> and <code>B</code>
1901 and hence is not TREESAME to either. The merge commit <code>R</code>, however, was
1902 created by ignoring the contents of <code>file.txt</code> at <code>M</code> and taking only
1903 the contents of <code>file.txt</code> at <code>X</code>. Hence, <code>R</code> is TREESAME to <code>X</code> but not
1904 <code>M</code>. Finally, the natural merge resolution to create <code>N</code> is to take the
1905 contents of <code>file.txt</code> at <code>R</code>, so <code>N</code> is TREESAME to <code>R</code> but not <code>C</code>.
1906 The merge commits <code>O</code> and <code>P</code> are TREESAME to their first parents, but
1907 not to their second parents, <code>Z</code> and <code>Y</code> respectively.</p></div>
1908 <div class="paragraph"><p>When using the default mode, <code>N</code> and <code>R</code> both have a TREESAME parent, so
1909 those edges are walked and the others are ignored. The resulting history
1910 graph is:</p></div>
1911 <div class="listingblock">
1912 <div class="content">
1913 <pre><code> I---X</code></pre>
1914 </div></div>
1915 <div class="paragraph"><p>When using <code>--full-history</code>, Git walks every edge. This will discover
1916 the commits <code>A</code> and <code>B</code> and the merge <code>M</code>, but also will reveal the
1917 merge commits <code>O</code> and <code>P</code>. With parent rewriting, the resulting graph is:</p></div>
1918 <div class="listingblock">
1919 <div class="content">
1920 <pre><code> .-A---M--------N---O---P
1921 / / \ \ \/ / /
1922 I B \ R-'`--' /
1923 \ / \/ /
1924 \ / /\ /
1925 `---X--' `------'</code></pre>
1926 </div></div>
1927 <div class="paragraph"><p>Here, the merge commits <code>O</code> and <code>P</code> contribute extra noise, as they did
1928 not actually contribute a change to <code>file.txt</code>. They only merged a topic
1929 that was based on an older version of <code>file.txt</code>. This is a common
1930 issue in repositories using a workflow where many contributors work in
1931 parallel and merge their topic branches along a single trunk: many
1932 unrelated merges appear in the <code>--full-history</code> results.</p></div>
1933 <div class="paragraph"><p>When using the <code>--simplify-merges</code> option, the commits <code>O</code> and <code>P</code>
1934 disappear from the results. This is because the rewritten second parents
1935 of <code>O</code> and <code>P</code> are reachable from their first parents. Those edges are
1936 removed and then the commits look like single-parent commits that are
1937 TREESAME to their parent. This also happens to the commit <code>N</code>, resulting
1938 in a history view as follows:</p></div>
1939 <div class="listingblock">
1940 <div class="content">
1941 <pre><code> .-A---M--.
1942 / / \
1943 I B R
1944 \ / /
1945 \ / /
1946 `---X--'</code></pre>
1947 </div></div>
1948 <div class="paragraph"><p>In this view, we see all of the important single-parent changes from
1949 <code>A</code>, <code>B</code>, and <code>X</code>. We also see the carefully-resolved merge <code>M</code> and the
1950 not-so-carefully-resolved merge <code>R</code>. This is usually enough information
1951 to determine why the commits <code>A</code> and <code>B</code> "disappeared" from history in
1952 the default view. However, there are a few issues with this approach.</p></div>
1953 <div class="paragraph"><p>The first issue is performance. Unlike any previous option, the
1954 <code>--simplify-merges</code> option requires walking the entire commit history
1955 before returning a single result. This can make the option difficult to
1956 use for very large repositories.</p></div>
1957 <div class="paragraph"><p>The second issue is one of auditing. When many contributors are working
1958 on the same repository, it is important which merge commits introduced
1959 a change into an important branch. The problematic merge <code>R</code> above is
1960 not likely to be the merge commit that was used to merge into an
1961 important branch. Instead, the merge <code>N</code> was used to merge <code>R</code> and <code>X</code>
1962 into the important branch. This commit may have information about why
1963 the change <code>X</code> came to override the changes from <code>A</code> and <code>B</code> in its
1964 commit message.</p></div>
1965 <div class="dlist"><dl>
1966 <dt class="hdlist1">
1967 --show-pulls
1968 </dt>
1969 <dd>
1971 In addition to the commits shown in the default history, show
1972 each merge commit that is not TREESAME to its first parent but
1973 is TREESAME to a later parent.
1974 </p>
1975 <div class="paragraph"><p>When a merge commit is included by <code>--show-pulls</code>, the merge is
1976 treated as if it "pulled" the change from another branch. When using
1977 <code>--show-pulls</code> on this example (and no other options) the resulting
1978 graph is:</p></div>
1979 <div class="listingblock">
1980 <div class="content">
1981 <pre><code> I---X---R---N</code></pre>
1982 </div></div>
1983 <div class="paragraph"><p>Here, the merge commits <code>R</code> and <code>N</code> are included because they pulled
1984 the commits <code>X</code> and <code>R</code> into the base branch, respectively. These
1985 merges are the reason the commits <code>A</code> and <code>B</code> do not appear in the
1986 default history.</p></div>
1987 <div class="paragraph"><p>When <code>--show-pulls</code> is paired with <code>--simplify-merges</code>, the
1988 graph includes all of the necessary information:</p></div>
1989 <div class="listingblock">
1990 <div class="content">
1991 <pre><code> .-A---M--. N
1992 / / \ /
1993 I B R
1994 \ / /
1995 \ / /
1996 `---X--'</code></pre>
1997 </div></div>
1998 <div class="paragraph"><p>Notice that since <code>M</code> is reachable from <code>R</code>, the edge from <code>N</code> to <code>M</code>
1999 was simplified away. However, <code>N</code> still appears in the history as an
2000 important commit because it "pulled" the change <code>R</code> into the main
2001 branch.</p></div>
2002 </dd>
2003 </dl></div>
2004 <div class="paragraph"><p>The <code>--simplify-by-decoration</code> option allows you to view only the
2005 big picture of the topology of the history, by omitting commits
2006 that are not referenced by tags. Commits are marked as !TREESAME
2007 (in other words, kept after history simplification rules described
2008 above) if (1) they are referenced by tags, or (2) they change the
2009 contents of the paths given on the command line. All other
2010 commits are marked as TREESAME (subject to be simplified away).</p></div>
2011 </div>
2012 </div>
2013 </div>
2014 <div class="sect1">
2015 <h2 id="_mapping_authors">MAPPING AUTHORS</h2>
2016 <div class="sectionbody">
2017 <div class="paragraph"><p>See <a href="gitmailmap.html">gitmailmap(5)</a>.</p></div>
2018 <div class="paragraph"><p>Note that if <code>git shortlog</code> is run outside of a repository (to process
2019 log contents on standard input), it will look for a <code>.mailmap</code> file in
2020 the current directory.</p></div>
2021 </div>
2022 </div>
2023 <div class="sect1">
2024 <h2 id="_git">GIT</h2>
2025 <div class="sectionbody">
2026 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
2027 </div>
2028 </div>
2029 </div>
2030 <div id="footnotes"><hr /></div>
2031 <div id="footer">
2032 <div id="footer-text">
2033 Last updated
2034 2022-11-04 21:49:36 PDT
2035 </div>
2036 </div>
2037 </body>
2038 </html>