Autogenerated HTML docs for v1.7.7-419-g87009
[git/jnareb-git.git] / gitdiffcore.html
blobf317ae4e9b0f466dcad663c7e1e60be47bbe7a05
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.5.2" />
7 <title>gitdiffcore(7)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 gitdiffcore(7) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>gitdiffcore -
578 Tweaking diff output
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git diff</em> *</div>
587 <div class="verseblock-attribution">
588 </div></div>
589 </div>
590 <h2 id="_description">DESCRIPTION</h2>
591 <div class="sectionbody">
592 <div class="paragraph"><p>The diff commands <em>git diff-index</em>, <em>git diff-files</em>, and <em>git diff-tree</em>
593 can be told to manipulate differences they find in
594 unconventional ways before showing <em>diff</em> output. The manipulation
595 is collectively called "diffcore transformation". This short note
596 describes what they are and how to use them to produce <em>diff</em> output
597 that is easier to understand than the conventional kind.</p></div>
598 </div>
599 <h2 id="_the_chain_of_operation">The chain of operation</h2>
600 <div class="sectionbody">
601 <div class="paragraph"><p>The <em>git diff-&#42;</em> family works by first comparing two sets of
602 files:</p></div>
603 <div class="ulist"><ul>
604 <li>
606 <em>git diff-index</em> compares contents of a "tree" object and the
607 working directory (when <em>--cached</em> flag is not used) or a
608 "tree" object and the index file (when <em>--cached</em> flag is
609 used);
610 </p>
611 </li>
612 <li>
614 <em>git diff-files</em> compares contents of the index file and the
615 working directory;
616 </p>
617 </li>
618 <li>
620 <em>git diff-tree</em> compares contents of two "tree" objects;
621 </p>
622 </li>
623 </ul></div>
624 <div class="paragraph"><p>In all of these cases, the commands themselves first optionally limit
625 the two sets of files by any pathspecs given on their command-lines,
626 and compare corresponding paths in the two resulting sets of files.</p></div>
627 <div class="paragraph"><p>The pathspecs are used to limit the world diff operates in. They remove
628 the filepairs outside the specified sets of pathnames. E.g. If the
629 input set of filepairs included:</p></div>
630 <div class="listingblock">
631 <div class="content">
632 <pre><tt>:100644 100644 bcd1234... 0123456... M junkfile</tt></pre>
633 </div></div>
634 <div class="paragraph"><p>but the command invocation was <tt>git diff-files myfile</tt>, then the
635 junkfile entry would be removed from the list because only "myfile"
636 is under consideration.</p></div>
637 <div class="paragraph"><p>The result of comparison is passed from these commands to what is
638 internally called "diffcore", in a format similar to what is output
639 when the -p option is not used. E.g.</p></div>
640 <div class="listingblock">
641 <div class="content">
642 <pre><tt>in-place edit :100644 100644 bcd1234... 0123456... M file0
643 create :000000 100644 0000000... 1234567... A file4
644 delete :100644 000000 1234567... 0000000... D file5
645 unmerged :000000 000000 0000000... 0000000... U file6</tt></pre>
646 </div></div>
647 <div class="paragraph"><p>The diffcore mechanism is fed a list of such comparison results
648 (each of which is called "filepair", although at this point each
649 of them talks about a single file), and transforms such a list
650 into another list. There are currently 5 such transformations:</p></div>
651 <div class="ulist"><ul>
652 <li>
654 diffcore-break
655 </p>
656 </li>
657 <li>
659 diffcore-rename
660 </p>
661 </li>
662 <li>
664 diffcore-merge-broken
665 </p>
666 </li>
667 <li>
669 diffcore-pickaxe
670 </p>
671 </li>
672 <li>
674 diffcore-order
675 </p>
676 </li>
677 </ul></div>
678 <div class="paragraph"><p>These are applied in sequence. The set of filepairs <em>git diff-&#42;</em>
679 commands find are used as the input to diffcore-break, and
680 the output from diffcore-break is used as the input to the
681 next transformation. The final result is then passed to the
682 output routine and generates either diff-raw format (see Output
683 format sections of the manual for <em>git diff-&#42;</em> commands) or
684 diff-patch format.</p></div>
685 </div>
686 <h2 id="_diffcore_break_for_splitting_up_complete_rewrites">diffcore-break: For Splitting Up "Complete Rewrites"</h2>
687 <div class="sectionbody">
688 <div class="paragraph"><p>The second transformation in the chain is diffcore-break, and is
689 controlled by the -B option to the <em>git diff-&#42;</em> commands. This is
690 used to detect a filepair that represents "complete rewrite" and
691 break such filepair into two filepairs that represent delete and
692 create. E.g. If the input contained this filepair:</p></div>
693 <div class="listingblock">
694 <div class="content">
695 <pre><tt>:100644 100644 bcd1234... 0123456... M file0</tt></pre>
696 </div></div>
697 <div class="paragraph"><p>and if it detects that the file "file0" is completely rewritten,
698 it changes it to:</p></div>
699 <div class="listingblock">
700 <div class="content">
701 <pre><tt>:100644 000000 bcd1234... 0000000... D file0
702 :000000 100644 0000000... 0123456... A file0</tt></pre>
703 </div></div>
704 <div class="paragraph"><p>For the purpose of breaking a filepair, diffcore-break examines
705 the extent of changes between the contents of the files before
706 and after modification (i.e. the contents that have "bcd1234&#8230;"
707 and "0123456&#8230;" as their SHA1 content ID, in the above
708 example). The amount of deletion of original contents and
709 insertion of new material are added together, and if it exceeds
710 the "break score", the filepair is broken into two. The break
711 score defaults to 50% of the size of the smaller of the original
712 and the result (i.e. if the edit shrinks the file, the size of
713 the result is used; if the edit lengthens the file, the size of
714 the original is used), and can be customized by giving a number
715 after "-B" option (e.g. "-B75" to tell it to use 75%).</p></div>
716 </div>
717 <h2 id="_diffcore_rename_for_detection_renames_and_copies">diffcore-rename: For Detection Renames and Copies</h2>
718 <div class="sectionbody">
719 <div class="paragraph"><p>This transformation is used to detect renames and copies, and is
720 controlled by the -M option (to detect renames) and the -C option
721 (to detect copies as well) to the <em>git diff-&#42;</em> commands. If the
722 input contained these filepairs:</p></div>
723 <div class="listingblock">
724 <div class="content">
725 <pre><tt>:100644 000000 0123456... 0000000... D fileX
726 :000000 100644 0000000... 0123456... A file0</tt></pre>
727 </div></div>
728 <div class="paragraph"><p>and the contents of the deleted file fileX is similar enough to
729 the contents of the created file file0, then rename detection
730 merges these filepairs and creates:</p></div>
731 <div class="listingblock">
732 <div class="content">
733 <pre><tt>:100644 100644 0123456... 0123456... R100 fileX file0</tt></pre>
734 </div></div>
735 <div class="paragraph"><p>When the "-C" option is used, the original contents of modified files,
736 and deleted files (and also unmodified files, if the
737 "--find-copies-harder" option is used) are considered as candidates
738 of the source files in rename/copy operation. If the input were like
739 these filepairs, that talk about a modified file fileY and a newly
740 created file file0:</p></div>
741 <div class="listingblock">
742 <div class="content">
743 <pre><tt>:100644 100644 0123456... 1234567... M fileY
744 :000000 100644 0000000... bcd3456... A file0</tt></pre>
745 </div></div>
746 <div class="paragraph"><p>the original contents of fileY and the resulting contents of
747 file0 are compared, and if they are similar enough, they are
748 changed to:</p></div>
749 <div class="listingblock">
750 <div class="content">
751 <pre><tt>:100644 100644 0123456... 1234567... M fileY
752 :100644 100644 0123456... bcd3456... C100 fileY file0</tt></pre>
753 </div></div>
754 <div class="paragraph"><p>In both rename and copy detection, the same "extent of changes"
755 algorithm used in diffcore-break is used to determine if two
756 files are "similar enough", and can be customized to use
757 a similarity score different from the default of 50% by giving a
758 number after the "-M" or "-C" option (e.g. "-M8" to tell it to use
759 8/10 = 80%).</p></div>
760 <div class="paragraph"><p>Note. When the "-C" option is used with <tt>--find-copies-harder</tt>
761 option, <em>git diff-&#42;</em> commands feed unmodified filepairs to
762 diffcore mechanism as well as modified ones. This lets the copy
763 detector consider unmodified files as copy source candidates at
764 the expense of making it slower. Without <tt>--find-copies-harder</tt>,
765 <em>git diff-&#42;</em> commands can detect copies only if the file that was
766 copied happened to have been modified in the same changeset.</p></div>
767 </div>
768 <h2 id="_diffcore_merge_broken_for_putting_complete_rewrites_back_together">diffcore-merge-broken: For Putting "Complete Rewrites" Back Together</h2>
769 <div class="sectionbody">
770 <div class="paragraph"><p>This transformation is used to merge filepairs broken by
771 diffcore-break, and not transformed into rename/copy by
772 diffcore-rename, back into a single modification. This always
773 runs when diffcore-break is used.</p></div>
774 <div class="paragraph"><p>For the purpose of merging broken filepairs back, it uses a
775 different "extent of changes" computation from the ones used by
776 diffcore-break and diffcore-rename. It counts only the deletion
777 from the original, and does not count insertion. If you removed
778 only 10 lines from a 100-line document, even if you added 910
779 new lines to make a new 1000-line document, you did not do a
780 complete rewrite. diffcore-break breaks such a case in order to
781 help diffcore-rename to consider such filepairs as candidate of
782 rename/copy detection, but if filepairs broken that way were not
783 matched with other filepairs to create rename/copy, then this
784 transformation merges them back into the original
785 "modification".</p></div>
786 <div class="paragraph"><p>The "extent of changes" parameter can be tweaked from the
787 default 80% (that is, unless more than 80% of the original
788 material is deleted, the broken pairs are merged back into a
789 single modification) by giving a second number to -B option,
790 like these:</p></div>
791 <div class="ulist"><ul>
792 <li>
794 -B50/60 (give 50% "break score" to diffcore-break, use 60%
795 for diffcore-merge-broken).
796 </p>
797 </li>
798 <li>
800 -B/60 (the same as above, since diffcore-break defaults to 50%).
801 </p>
802 </li>
803 </ul></div>
804 <div class="paragraph"><p>Note that earlier implementation left a broken pair as a separate
805 creation and deletion patches. This was an unnecessary hack and
806 the latest implementation always merges all the broken pairs
807 back into modifications, but the resulting patch output is
808 formatted differently for easier review in case of such
809 a complete rewrite by showing the entire contents of old version
810 prefixed with <em>-</em>, followed by the entire contents of new
811 version prefixed with <em>+</em>.</p></div>
812 </div>
813 <h2 id="_diffcore_pickaxe_for_detecting_addition_deletion_of_specified_string">diffcore-pickaxe: For Detecting Addition/Deletion of Specified String</h2>
814 <div class="sectionbody">
815 <div class="paragraph"><p>This transformation is used to find filepairs that represent
816 changes that touch a specified string, and is controlled by the
817 -S option and the <tt>--pickaxe-all</tt> option to the <em>git diff-&#42;</em>
818 commands.</p></div>
819 <div class="paragraph"><p>When diffcore-pickaxe is in use, it checks if there are
820 filepairs whose "result" side and whose "origin" side have
821 different number of specified string. Such a filepair represents
822 "the string appeared in this changeset". It also checks for the
823 opposite case that loses the specified string.</p></div>
824 <div class="paragraph"><p>When <tt>--pickaxe-all</tt> is not in effect, diffcore-pickaxe leaves
825 only such filepairs that touch the specified string in its
826 output. When <tt>--pickaxe-all</tt> is used, diffcore-pickaxe leaves all
827 filepairs intact if there is such a filepair, or makes the
828 output empty otherwise. The latter behaviour is designed to
829 make reviewing of the changes in the context of the whole
830 changeset easier.</p></div>
831 </div>
832 <h2 id="_diffcore_order_for_sorting_the_output_based_on_filenames">diffcore-order: For Sorting the Output Based on Filenames</h2>
833 <div class="sectionbody">
834 <div class="paragraph"><p>This is used to reorder the filepairs according to the user&#8217;s
835 (or project&#8217;s) taste, and is controlled by the -O option to the
836 <em>git diff-&#42;</em> commands.</p></div>
837 <div class="paragraph"><p>This takes a text file each of whose lines is a shell glob
838 pattern. Filepairs that match a glob pattern on an earlier line
839 in the file are output before ones that match a later line, and
840 filepairs that do not match any glob pattern are output last.</p></div>
841 <div class="paragraph"><p>As an example, a typical orderfile for the core git probably
842 would look like this:</p></div>
843 <div class="listingblock">
844 <div class="content">
845 <pre><tt>README
846 Makefile
847 Documentation
850 t</tt></pre>
851 </div></div>
852 </div>
853 <h2 id="_see_also">SEE ALSO</h2>
854 <div class="sectionbody">
855 <div class="paragraph"><p><a href="git-diff.html">git-diff(1)</a>,
856 <a href="git-diff-files.html">git-diff-files(1)</a>,
857 <a href="git-diff-index.html">git-diff-index(1)</a>,
858 <a href="git-diff-tree.html">git-diff-tree(1)</a>,
859 <a href="git-format-patch.html">git-format-patch(1)</a>,
860 <a href="git-log.html">git-log(1)</a>,
861 <a href="gitglossary.html">gitglossary(7)</a>,
862 <a href="user-manual.html">The Git User&#8217;s Manual</a></p></div>
863 </div>
864 <h2 id="_git">GIT</h2>
865 <div class="sectionbody">
866 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite.</p></div>
867 </div>
868 </div>
869 <div id="footnotes"><hr /></div>
870 <div id="footer">
871 <div id="footer-text">
872 Last updated 2011-09-21 23:01:14 PDT
873 </div>
874 </div>
875 </body>
876 </html>