blob: 457bfcbc60ae06f5d69304a696c30c4a12fb6bf8 [file] [log] [blame]
Junio C Hamano11ae3202018-08-20 20:15:421<?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 8.6.10" />
8<title>git-range-diff(1)</title>
9<style type="text/css">
10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
38
39em {
40 font-style: italic;
41 color: navy;
42}
43
44strong {
45 font-weight: bold;
46 color: #083194;
47}
48
49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
56h1, h2, h3 {
57 border-bottom: 2px solid silver;
58}
59h2 {
60 padding-top: 0.5em;
61}
62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
68h5 {
69 font-size: 1.0em;
70}
71
72div.sectionbody {
73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
85ul, ol, li > p {
86 margin-top: 0;
87}
88ul > li { color: #aaa; }
89ul > li > * { color: black; }
90
91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
97}
98pre {
99 white-space: pre-wrap;
100}
101
102#author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
106}
107#email {
108}
109#revnumber, #revdate, #revremark {
110}
111
112#footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
118#footer-text {
119 float: left;
120 padding-bottom: 0.5em;
121}
122#footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
125}
126
127#preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
131div.imageblock, div.exampleblock, div.verseblock,
132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
182}
183
184div.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;
190}
191
192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
195}
196
197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206div.verseblock + div.attribution {
207 text-align: left;
208}
209
210div.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;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
221}
222
223div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
226}
227
228div.imageblock div.content { padding-left: 0; }
229span.image img { border-style: none; vertical-align: text-bottom; }
230a.image:visited { color: white; }
231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
241}
242dd > *:first-child {
243 margin-top: 0.1em;
244}
245
246ul, ol {
247 list-style-position: outside;
248}
249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
253 list-style-type: lower-alpha;
254}
255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
271
272tfoot {
273 font-weight: bold;
274}
275td > div.verse {
276 white-space: pre;
277}
278
279div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
283div.hdlist tr {
284 padding-bottom: 15px;
285}
286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
294}
295td.hdlist2 {
296 vertical-align: top;
297}
298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
306
307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
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;
332}
333
334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
341}
342
343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
348 margin-bottom: 2.5em;
349}
350
351#toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
417div.unbreakable { page-break-inside: avoid; }
418
419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
439/* Because the table frame attribute is overriden by CSS in most browsers. */
440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
527body.manpage h2 {
528 border-style: none;
529}
530body.manpage div.sectionbody {
531 margin-left: 3em;
532}
533
534@media print {
535 body.manpage div#toc { display: none; }
536}
537
538
539</style>
540<script type="text/javascript">
541/*<![CDATA[*/
542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
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.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
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);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
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);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
605 }
606
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);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
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);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: 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;
654 }
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);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
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);
682 }
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;
689 }
690 }
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>]";
703 }
704 }
705 }
706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
728}
729
730}
731asciidoc.install();
732/*]]>*/
733</script>
734</head>
735<body class="manpage">
736<div id="header">
737<h1>
738git-range-diff(1) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>git-range-diff -
743 Compare two commit ranges (e.g. two versions of a branch)
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 range-diff</em> [--color=[&lt;when&gt;]] [--no-color] [&lt;diff-options&gt;]
753 [--no-dual-color] [--creation-factor=&lt;factor&gt;]
754 ( &lt;range1&gt; &lt;range2&gt; | &lt;rev1&gt;&#8230;&lt;rev2&gt; | &lt;base&gt; &lt;rev1&gt; &lt;rev2&gt; )</pre>
755<div class="attribution">
756</div></div>
757</div>
758</div>
759<div class="sect1">
760<h2 id="_description">DESCRIPTION</h2>
761<div class="sectionbody">
762<div class="paragraph"><p>This command shows the differences between two versions of a patch
763series, or more generally, two commit ranges (ignoring merge commits).</p></div>
764<div class="paragraph"><p>To that end, it first finds pairs of commits from both commit ranges
765that correspond with each other. Two commits are said to correspond when
766the diff between their patches (i.e. the author information, the commit
767message and the commit diff) is reasonably small compared to the
768patches' size. See ``Algorithm`` below for details.</p></div>
769<div class="paragraph"><p>Finally, the list of matching commits is shown in the order of the
770second commit range, with unmatched commits being inserted just after
771all of their ancestors have been shown.</p></div>
772</div>
773</div>
774<div class="sect1">
775<h2 id="_options">OPTIONS</h2>
776<div class="sectionbody">
777<div class="dlist"><dl>
778<dt class="hdlist1">
779--no-dual-color
780</dt>
781<dd>
782<p>
783 When the commit diffs differ, &#8216;git range-diff` recreates the
784 original diffs&#8217; coloring, and adds outer -/+ diff markers with
785 the <strong>background</strong> being red/green to make it easier to see e.g.
786 when there was a change in what exact lines were added.
787</p>
788<div class="paragraph"><p>Additionally, the commit diff lines that are only present in the first commit
789range are shown "dimmed" (this can be overridden using the <code>color.diff.&lt;slot&gt;</code>
790config setting where <code>&lt;slot&gt;</code> is one of <code>contextDimmed</code>, <code>oldDimmed</code> and
791<code>newDimmed</code>), and the commit diff lines that are only present in the second
792commit range are shown in bold (which can be overridden using the config
793settings <code>color.diff.&lt;slot&gt;</code> with <code>&lt;slot&gt;</code> being one of <code>contextBold</code>,
794<code>oldBold</code> or <code>newBold</code>).</p></div>
795<div class="paragraph"><p>This is known to <code>range-diff</code> as "dual coloring". Use <code>--no-dual-color</code>
796to revert to color all lines according to the outer diff markers
797(and completely ignore the inner diff when it comes to color).</p></div>
798</dd>
799<dt class="hdlist1">
800--creation-factor=&lt;percent&gt;
801</dt>
802<dd>
803<p>
804 Set the creation/deletion cost fudge factor to <code>&lt;percent&gt;</code>.
805 Defaults to 60. Try a larger value if <code>git range-diff</code> erroneously
806 considers a large change a total rewrite (deletion of one commit
807 and addition of another), and a smaller one in the reverse case.
808 See the ``Algorithm`` section below for an explanation why this is
809 needed.
810</p>
811</dd>
812<dt class="hdlist1">
813&lt;range1&gt; &lt;range2&gt;
814</dt>
815<dd>
816<p>
817 Compare the commits specified by the two ranges, where
818 <code>&lt;range1&gt;</code> is considered an older version of <code>&lt;range2&gt;</code>.
819</p>
820</dd>
821<dt class="hdlist1">
822&lt;rev1&gt;&#8230;&lt;rev2&gt;
823</dt>
824<dd>
825<p>
826 Equivalent to passing <code>&lt;rev2&gt;..&lt;rev1&gt;</code> and <code>&lt;rev1&gt;..&lt;rev2&gt;</code>.
827</p>
828</dd>
829<dt class="hdlist1">
830&lt;base&gt; &lt;rev1&gt; &lt;rev2&gt;
831</dt>
832<dd>
833<p>
834 Equivalent to passing <code>&lt;base&gt;..&lt;rev1&gt;</code> and <code>&lt;base&gt;..&lt;rev2&gt;</code>.
835 Note that <code>&lt;base&gt;</code> does not need to be the exact branch point
836 of the branches. Example: after rebasing a branch <code>my-topic</code>,
837 <code>git range-diff my-topic@{u} my-topic@{1} my-topic</code> would
838 show the differences introduced by the rebase.
839</p>
840</dd>
841</dl></div>
842<div class="paragraph"><p><code>git range-diff</code> also accepts the regular diff options (see
843<a href="git-diff.html">git-diff(1)</a>), most notably the <code>--color=[&lt;when&gt;]</code> and
844<code>--no-color</code> options. These options are used when generating the "diff
845between patches", i.e. to compare the author, commit message and diff of
846corresponding old/new commits. There is currently no means to tweak the
847diff options passed to <code>git log</code> when generating those patches.</p></div>
848</div>
849</div>
850<div class="sect1">
Junio C Hamano69bb2b52018-11-18 12:44:26851<h2 id="_output_stability">OUTPUT STABILITY</h2>
852<div class="sectionbody">
853<div class="paragraph"><p>The output of the <code>range-diff</code> command is subject to change. It is
854intended to be human-readable porcelain output, not something that can
855be used across versions of Git to get a textually stable <code>range-diff</code>
856(as opposed to something like the <code>--stable</code> option to
857<a href="git-patch-id.html">git-patch-id(1)</a>). There&#8217;s also no equivalent of
858<a href="git-apply.html">git-apply(1)</a> for <code>range-diff</code>, the output is not intended to
859be machine-readable.</p></div>
860<div class="paragraph"><p>This is particularly true when passing in diff options. Currently some
861options like <code>--stat</code> can, as an emergent effect, produce output
862that&#8217;s quite useless in the context of <code>range-diff</code>. Future versions
863of <code>range-diff</code> may learn to interpret such options in a manner
864specific to <code>range-diff</code> (e.g. for <code>--stat</code> producing human-readable
865output which summarizes how the diffstat changed).</p></div>
866</div>
867</div>
868<div class="sect1">
Junio C Hamano11ae3202018-08-20 20:15:42869<h2 id="_configuration">CONFIGURATION</h2>
870<div class="sectionbody">
871<div class="paragraph"><p>This command uses the <code>diff.color.*</code> and <code>pager.range-diff</code> settings
872(the latter is on by default).
873See <a href="git-config.html">git-config(1)</a>.</p></div>
874</div>
875</div>
876<div class="sect1">
877<h2 id="_examples">EXAMPLES</h2>
878<div class="sectionbody">
879<div class="paragraph"><p>When a rebase required merge conflicts to be resolved, compare the changes
880introduced by the rebase directly afterwards using:</p></div>
881<div class="listingblock">
882<div class="content">
883<pre><code>$ git range-diff @{u} @{1} @</code></pre>
884</div></div>
885<div class="paragraph"><p>A typical output of <code>git range-diff</code> would look like this:</p></div>
886<div class="listingblock">
887<div class="content">
888<pre><code>-: ------- &gt; 1: 0ddba11 Prepare for the inevitable!
8891: c0debee = 2: cab005e Add a helpful message at the start
8902: f00dbal ! 3: decafe1 Describe a bug
891 @@ -1,3 +1,3 @@
892 Author: A U Thor &lt;author@example.com&gt;
893
894 -TODO: Describe a bug
895 +Describe a bug
896 @@ -324,5 +324,6
897 This is expected.
898
899 -+What is unexpected is that it will also crash.
900 ++Unexpectedly, it also crashes. This is a bug, and the jury is
901 ++still out there how to fix it best. See ticket #314 for details.
902
903 Contact
9043: bedead &lt; -: ------- TO-UNDO</code></pre>
905</div></div>
906<div class="paragraph"><p>In this example, there are 3 old and 3 new commits, where the developer
907removed the 3rd, added a new one before the first two, and modified the
908commit message of the 2nd commit as well its diff.</p></div>
909<div class="paragraph"><p>When the output goes to a terminal, it is color-coded by default, just
910like regular <code>git diff</code>'s output. In addition, the first line (adding a
911commit) is green, the last line (deleting a commit) is red, the second
912line (with a perfect match) is yellow like the commit header of <code>git
913show</code>'s output, and the third line colors the old commit red, the new
914one green and the rest like <code>git show</code>'s commit header.</p></div>
915<div class="paragraph"><p>A naive color-coded diff of diffs is actually a bit hard to read,
916though, as it colors the entire lines red or green. The line that added
917"What is unexpected" in the old commit, for example, is completely red,
918even if the intent of the old commit was to add something.</p></div>
919<div class="paragraph"><p>To help with that, <code>range</code> uses the <code>--dual-color</code> mode by default. In
920this mode, the diff of diffs will retain the original diff colors, and
921prefix the lines with -/+ markers that have their <strong>background</strong> red or
922green, to make it more obvious that they describe how the diff itself
923changed.</p></div>
924</div>
925</div>
926<div class="sect1">
927<h2 id="_algorithm">Algorithm</h2>
928<div class="sectionbody">
929<div class="paragraph"><p>The general idea is this: we generate a cost matrix between the commits
930in both commit ranges, then solve the least-cost assignment.</p></div>
931<div class="paragraph"><p>The cost matrix is populated thusly: for each pair of commits, both
932diffs are generated and the "diff of diffs" is generated, with 3 context
933lines, then the number of lines in that diff is used as cost.</p></div>
934<div class="paragraph"><p>To avoid false positives (e.g. when a patch has been removed, and an
935unrelated patch has been added between two iterations of the same patch
936series), the cost matrix is extended to allow for that, by adding
937fixed-cost entries for wholesale deletes/adds.</p></div>
938<div class="paragraph"><p>Example: Let commits <code>1--2</code> be the first iteration of a patch series and
939<code>A--C</code> the second iteration. Let&#8217;s assume that <code>A</code> is a cherry-pick of
940<code>2,</code> and <code>C</code> is a cherry-pick of <code>1</code> but with a small modification (say,
941a fixed typo). Visualize the commits as a bipartite graph:</p></div>
942<div class="listingblock">
943<div class="content">
944<pre><code> 1 A
945
946 2 B
947
948 C</code></pre>
949</div></div>
950<div class="paragraph"><p>We are looking for a "best" explanation of the new series in terms of
951the old one. We can represent an "explanation" as an edge in the graph:</p></div>
952<div class="listingblock">
953<div class="content">
954<pre><code> 1 A
955 /
956 2 --------' B
957
958 C</code></pre>
959</div></div>
960<div class="paragraph"><p>This explanation comes for "free" because there was no change. Similarly
961<code>C</code> could be explained using <code>1</code>, but that comes at some cost c&gt;0
962because of the modification:</p></div>
963<div class="listingblock">
964<div class="content">
965<pre><code> 1 ----. A
966 | /
967 2 ----+---' B
968 |
969 `----- C
970 c&gt;0</code></pre>
971</div></div>
972<div class="paragraph"><p>In mathematical terms, what we are looking for is some sort of a minimum
973cost bipartite matching; &#8216;1` is matched to <code>C</code> at some cost, etc. The
974underlying graph is in fact a complete bipartite graph; the cost we
975associate with every edge is the size of the diff between the two
976commits&#8217; patches. To explain also new commits, we introduce dummy nodes
977on both sides:</p></div>
978<div class="listingblock">
979<div class="content">
980<pre><code> 1 ----. A
981 | /
982 2 ----+---' B
983 |
984 o `----- C
985 c&gt;0
986 o o
987
988 o o</code></pre>
989</div></div>
990<div class="paragraph"><p>The cost of an edge <code>o--C</code> is the size of <code>C</code>'s diff, modified by a
991fudge factor that should be smaller than 100%. The cost of an edge
992<code>o--o</code> is free. The fudge factor is necessary because even if <code>1</code> and
993<code>C</code> have nothing in common, they may still share a few empty lines and
994such, possibly making the assignment <code>1--C</code>, <code>o--o</code> slightly cheaper
995than <code>1--o</code>, <code>o--C</code> even if <code>1</code> and <code>C</code> have nothing in common. With the
996fudge factor we require a much larger common part to consider patches as
997corresponding.</p></div>
998<div class="paragraph"><p>The overall time needed to compute this algorithm is the time needed to
999compute n+m commit diffs and then n*m diffs of patches, plus the time
1000needed to compute the least-cost assigment between n and m diffs. Git
1001uses an implementation of the Jonker-Volgenant algorithm to solve the
1002assignment problem, which has cubic runtime complexity. The matching
1003found in this case will look like this:</p></div>
1004<div class="listingblock">
1005<div class="content">
1006<pre><code> 1 ----. A
1007 | /
1008 2 ----+---' B
1009 .--+-----'
1010 o -' `----- C
1011 c&gt;0
1012 o ---------- o
1013
1014 o ---------- o</code></pre>
1015</div></div>
1016</div>
1017</div>
1018<div class="sect1">
1019<h2 id="_see_also">SEE ALSO</h2>
1020<div class="sectionbody">
1021<div class="paragraph"><p><a href="git-log.html">git-log(1)</a></p></div>
1022</div>
1023</div>
1024<div class="sect1">
1025<h2 id="_git">GIT</h2>
1026<div class="sectionbody">
1027<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1028</div>
1029</div>
1030</div>
1031<div id="footnotes"><hr /></div>
1032<div id="footer">
1033<div id="footer-text">
1034Last updated
Junio C Hamano69bb2b52018-11-18 12:44:261035 2018-11-18 21:41:21 JST
Junio C Hamano11ae3202018-08-20 20:15:421036</div>
1037</div>
1038</body>
1039</html>