"Fossies" - the Fresh Open Source Software Archive

Member "technical/api-diff.html" (15 Dec 2018, 25439 Bytes) of package /linux/misc/git-htmldocs-2.20.1.tar.xz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    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 8.6.10" />
    8 <title>diff API</title>
    9 <style type="text/css">
   10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
   11 
   12 /* Default font. */
   13 body {
   14   font-family: Georgia,serif;
   15 }
   16 
   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;
   25 }
   26 
   27 body {
   28   margin: 1em 5% 1em 5%;
   29 }
   30 
   31 a {
   32   color: blue;
   33   text-decoration: underline;
   34 }
   35 a:visited {
   36   color: fuchsia;
   37 }
   38 
   39 em {
   40   font-style: italic;
   41   color: navy;
   42 }
   43 
   44 strong {
   45   font-weight: bold;
   46   color: #083194;
   47 }
   48 
   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;
   54 }
   55 
   56 h1, h2, h3 {
   57   border-bottom: 2px solid silver;
   58 }
   59 h2 {
   60   padding-top: 0.5em;
   61 }
   62 h3 {
   63   float: left;
   64 }
   65 h3 + * {
   66   clear: left;
   67 }
   68 h5 {
   69   font-size: 1.0em;
   70 }
   71 
   72 div.sectionbody {
   73   margin-left: 0;
   74 }
   75 
   76 hr {
   77   border: 1px solid silver;
   78 }
   79 
   80 p {
   81   margin-top: 0.5em;
   82   margin-bottom: 0.5em;
   83 }
   84 
   85 ul, ol, li > p {
   86   margin-top: 0;
   87 }
   88 ul > li     { color: #aaa; }
   89 ul > 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 }
   98 pre {
   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 }
  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;
  136 }
  137 div.admonitionblock {
  138   margin-top: 2.0em;
  139   margin-bottom: 2.0em;
  140   margin-right: 10%;
  141   color: #606060;
  142 }
  143 
  144 div.content { /* Block element content. */
  145   padding: 0;
  146 }
  147 
  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;
  155 }
  156 div.title + * {
  157   margin-top: 0;
  158 }
  159 
  160 td div.title:first-child {
  161   margin-top: 0.0em;
  162 }
  163 div.content div.title:first-child {
  164   margin-top: 0.0em;
  165 }
  166 div.content + div.title {
  167   margin-top: 0.0em;
  168 }
  169 
  170 div.sidebarblock > div.content {
  171   background: #ffffee;
  172   border: 1px solid #dddddd;
  173   border-left: 4px solid #f0f0f0;
  174   padding: 0.5em;
  175 }
  176 
  177 div.listingblock > div.content {
  178   border: 1px solid #dddddd;
  179   border-left: 5px solid #f0f0f0;
  180   background: #f8f8f8;
  181   padding: 0.5em;
  182 }
  183 
  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;
  190 }
  191 
  192 div.quoteblock > div.attribution {
  193   padding-top: 0.5em;
  194   text-align: right;
  195 }
  196 
  197 div.verseblock > pre.content {
  198   font-family: inherit;
  199   font-size: inherit;
  200 }
  201 div.verseblock > div.attribution {
  202   padding-top: 0.75em;
  203   text-align: left;
  204 }
  205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
  206 div.verseblock + div.attribution {
  207   text-align: left;
  208 }
  209 
  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;
  217 }
  218 div.admonitionblock td.content {
  219   padding-left: 0.5em;
  220   border-left: 3px solid #dddddd;
  221 }
  222 
  223 div.exampleblock > div.content {
  224   border-left: 3px solid #dddddd;
  225   padding-left: 0.5em;
  226 }
  227 
  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; }
  231 
  232 dl {
  233   margin-top: 0.8em;
  234   margin-bottom: 0.8em;
  235 }
  236 dt {
  237   margin-top: 0.5em;
  238   margin-bottom: 0;
  239   font-style: normal;
  240   color: navy;
  241 }
  242 dd > *:first-child {
  243   margin-top: 0.1em;
  244 }
  245 
  246 ul, ol {
  247     list-style-position: outside;
  248 }
  249 ol.arabic {
  250   list-style-type: decimal;
  251 }
  252 ol.loweralpha {
  253   list-style-type: lower-alpha;
  254 }
  255 ol.upperalpha {
  256   list-style-type: upper-alpha;
  257 }
  258 ol.lowerroman {
  259   list-style-type: lower-roman;
  260 }
  261 ol.upperroman {
  262   list-style-type: upper-roman;
  263 }
  264 
  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;
  270 }
  271 
  272 tfoot {
  273   font-weight: bold;
  274 }
  275 td > div.verse {
  276   white-space: pre;
  277 }
  278 
  279 div.hdlist {
  280   margin-top: 0.8em;
  281   margin-bottom: 0.8em;
  282 }
  283 div.hdlist tr {
  284   padding-bottom: 15px;
  285 }
  286 dt.hdlist1.strong, td.hdlist1.strong {
  287   font-weight: bold;
  288 }
  289 td.hdlist1 {
  290   vertical-align: top;
  291   font-style: normal;
  292   padding-right: 0.8em;
  293   color: navy;
  294 }
  295 td.hdlist2 {
  296   vertical-align: top;
  297 }
  298 div.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 
  311 span.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 
  334 div.colist td {
  335   padding-right: 0.5em;
  336   padding-bottom: 0.3em;
  337   vertical-align: top;
  338 }
  339 div.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 
  359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  360   margin-top: 0;
  361   margin-bottom: 0;
  362 }
  363 div.toclevel2 {
  364   margin-left: 2em;
  365   font-size: 0.9em;
  366 }
  367 div.toclevel3 {
  368   margin-left: 4em;
  369   font-size: 0.9em;
  370 }
  371 div.toclevel4 {
  372   margin-left: 6em;
  373   font-size: 0.9em;
  374 }
  375 
  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; }
  392 
  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; }
  409 
  410 span.big { font-size: 2em; }
  411 span.small { font-size: 0.6em; }
  412 
  413 span.underline { text-decoration: underline; }
  414 span.overline { text-decoration: overline; }
  415 span.line-through { text-decoration: line-through; }
  416 
  417 div.unbreakable { page-break-inside: avoid; }
  418 
  419 
  420 /*
  421  * xhtml11 specific
  422  *
  423  * */
  424 
  425 div.tableblock {
  426   margin-top: 1.0em;
  427   margin-bottom: 1.5em;
  428 }
  429 div.tableblock > table {
  430   border: 3px solid #527bbd;
  431 }
  432 thead, p.table.header {
  433   font-weight: bold;
  434   color: #527bbd;
  435 }
  436 p.table {
  437   margin-top: 0;
  438 }
  439 /* Because the table frame attribute is overriden by CSS in most browsers. */
  440 div.tableblock > table[frame="void"] {
  441   border-style: none;
  442 }
  443 div.tableblock > table[frame="hsides"] {
  444   border-left-style: none;
  445   border-right-style: none;
  446 }
  447 div.tableblock > table[frame="vsides"] {
  448   border-top-style: none;
  449   border-bottom-style: none;
  450 }
  451 
  452 
  453 /*
  454  * html5 specific
  455  *
  456  * */
  457 
  458 table.tableblock {
  459   margin-top: 1.0em;
  460   margin-bottom: 1.5em;
  461 }
  462 thead, p.tableblock.header {
  463   font-weight: bold;
  464   color: #527bbd;
  465 }
  466 p.tableblock {
  467   margin-top: 0;
  468 }
  469 table.tableblock {
  470   border-width: 3px;
  471   border-spacing: 0px;
  472   border-style: solid;
  473   border-color: #527bbd;
  474   border-collapse: collapse;
  475 }
  476 th.tableblock, td.tableblock {
  477   border-width: 1px;
  478   padding: 4px;
  479   border-style: solid;
  480   border-color: #527bbd;
  481 }
  482 
  483 table.tableblock.frame-topbot {
  484   border-left-style: hidden;
  485   border-right-style: hidden;
  486 }
  487 table.tableblock.frame-sides {
  488   border-top-style: hidden;
  489   border-bottom-style: hidden;
  490 }
  491 table.tableblock.frame-none {
  492   border-style: hidden;
  493 }
  494 
  495 th.tableblock.halign-left, td.tableblock.halign-left {
  496   text-align: left;
  497 }
  498 th.tableblock.halign-center, td.tableblock.halign-center {
  499   text-align: center;
  500 }
  501 th.tableblock.halign-right, td.tableblock.halign-right {
  502   text-align: right;
  503 }
  504 
  505 th.tableblock.valign-top, td.tableblock.valign-top {
  506   vertical-align: top;
  507 }
  508 th.tableblock.valign-middle, td.tableblock.valign-middle {
  509   vertical-align: middle;
  510 }
  511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
  512   vertical-align: bottom;
  513 }
  514 
  515 
  516 /*
  517  * manpage specific
  518  *
  519  * */
  520 
  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;
  526 }
  527 body.manpage h2 {
  528   border-style: none;
  529 }
  530 body.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[*/
  542 var 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.
  562 toc: 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 
  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;
  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 
  708 install: 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 }
  731 asciidoc.install();
  732 /*]]>*/
  733 </script>
  734 </head>
  735 <body class="article">
  736 <div id="header">
  737 <h1>diff API</h1>
  738 </div>
  739 <div id="content">
  740 <div id="preamble">
  741 <div class="sectionbody">
  742 <div class="paragraph"><p>The diff API is for programs that compare two sets of files (e.g. two
  743 trees, one tree and the index) and present the found difference in
  744 various ways.  The calling program is responsible for feeding the API
  745 pairs of files, one from the "old" set and the corresponding one from
  746 "new" set, that are different.  The library called through this API is
  747 called diffcore, and is responsible for two things.</p></div>
  748 <div class="ulist"><ul>
  749 <li>
  750 <p>
  751 finding total rewrites (<code>-B</code>), renames (<code>-M</code>) and copies (<code>-C</code>), and
  752   changes that touch a string (<code>-S</code>), as specified by the caller.
  753 </p>
  754 </li>
  755 <li>
  756 <p>
  757 outputting the differences in various formats, as specified by the
  758   caller.
  759 </p>
  760 </li>
  761 </ul></div>
  762 </div>
  763 </div>
  764 <div class="sect1">
  765 <h2 id="_calling_sequence">Calling sequence</h2>
  766 <div class="sectionbody">
  767 <div class="ulist"><ul>
  768 <li>
  769 <p>
  770 Prepare <code>struct diff_options</code> to record the set of diff options, and
  771   then call <code>repo_diff_setup()</code> to initialize this structure.  This
  772   sets up the vanilla default.
  773 </p>
  774 </li>
  775 <li>
  776 <p>
  777 Fill in the options structure to specify desired output format, rename
  778   detection, etc.  <code>diff_opt_parse()</code> can be used to parse options given
  779   from the command line in a way consistent with existing git-diff
  780   family of programs.
  781 </p>
  782 </li>
  783 <li>
  784 <p>
  785 Call <code>diff_setup_done()</code>; this inspects the options set up so far for
  786   internal consistency and make necessary tweaking to it (e.g. if
  787   textual patch output was asked, recursive behaviour is turned on);
  788   the callback set_default in diff_options can be used to tweak this more.
  789 </p>
  790 </li>
  791 <li>
  792 <p>
  793 As you find different pairs of files, call <code>diff_change()</code> to feed
  794   modified files, <code>diff_addremove()</code> to feed created or deleted files,
  795   or <code>diff_unmerge()</code> to feed a file whose state is <em>unmerged</em> to the
  796   API.  These are thin wrappers to a lower-level <code>diff_queue()</code> function
  797   that is flexible enough to record any of these kinds of changes.
  798 </p>
  799 </li>
  800 <li>
  801 <p>
  802 Once you finish feeding the pairs of files, call <code>diffcore_std()</code>.
  803   This will tell the diffcore library to go ahead and do its work.
  804 </p>
  805 </li>
  806 <li>
  807 <p>
  808 Calling <code>diff_flush()</code> will produce the output.
  809 </p>
  810 </li>
  811 </ul></div>
  812 </div>
  813 </div>
  814 <div class="sect1">
  815 <h2 id="_data_structures">Data structures</h2>
  816 <div class="sectionbody">
  817 <div class="ulist"><ul>
  818 <li>
  819 <p>
  820 <code>struct diff_filespec</code>
  821 </p>
  822 </li>
  823 </ul></div>
  824 <div class="paragraph"><p>This is the internal representation for a single file (blob).  It
  825 records the blob object name (if known&#8201;&#8212;&#8201;for a work tree file it
  826 typically is a NUL SHA-1), filemode and pathname.  This is what the
  827 <code>diff_addremove()</code>, <code>diff_change()</code> and <code>diff_unmerge()</code> synthesize and
  828 feed <code>diff_queue()</code> function with.</p></div>
  829 <div class="ulist"><ul>
  830 <li>
  831 <p>
  832 <code>struct diff_filepair</code>
  833 </p>
  834 </li>
  835 </ul></div>
  836 <div class="paragraph"><p>This records a pair of <code>struct diff_filespec</code>; the filespec for a file
  837 in the "old" set (i.e. preimage) is called <code>one</code>, and the filespec for a
  838 file in the "new" set (i.e. postimage) is called <code>two</code>.  A change that
  839 represents file creation has NULL in <code>one</code>, and file deletion has NULL
  840 in <code>two</code>.</p></div>
  841 <div class="paragraph"><p>A <code>filepair</code> starts pointing at <code>one</code> and <code>two</code> that are from the same
  842 filename, but <code>diffcore_std()</code> can break pairs and match component
  843 filespecs with other filespecs from a different filepair to form new
  844 filepair.  This is called <em>rename detection</em>.</p></div>
  845 <div class="ulist"><ul>
  846 <li>
  847 <p>
  848 <code>struct diff_queue</code>
  849 </p>
  850 </li>
  851 </ul></div>
  852 <div class="paragraph"><p>This is a collection of filepairs.  Notable members are:</p></div>
  853 <div class="dlist"><dl>
  854 <dt class="hdlist1">
  855 <code>queue</code>
  856 </dt>
  857 <dd>
  858 <p>
  859         An array of pointers to <code>struct diff_filepair</code>.  This
  860         dynamically grows as you add filepairs;
  861 </p>
  862 </dd>
  863 <dt class="hdlist1">
  864 <code>alloc</code>
  865 </dt>
  866 <dd>
  867 <p>
  868         The allocated size of the <code>queue</code> array;
  869 </p>
  870 </dd>
  871 <dt class="hdlist1">
  872 <code>nr</code>
  873 </dt>
  874 <dd>
  875 <p>
  876         The number of elements in the <code>queue</code> array.
  877 </p>
  878 <div class="ulist"><ul>
  879 <li>
  880 <p>
  881 <code>struct diff_options</code>
  882 </p>
  883 </li>
  884 </ul></div>
  885 </dd>
  886 </dl></div>
  887 <div class="paragraph"><p>This describes the set of options the calling program wants to affect
  888 the operation of diffcore library with.</p></div>
  889 <div class="paragraph"><p>Notable members are:</p></div>
  890 <div class="dlist"><dl>
  891 <dt class="hdlist1">
  892 <code>output_format</code>
  893 </dt>
  894 <dd>
  895 <p>
  896         The output format used when <code>diff_flush()</code> is run.
  897 </p>
  898 </dd>
  899 <dt class="hdlist1">
  900 <code>context</code>
  901 </dt>
  902 <dd>
  903 <p>
  904         Number of context lines to generate in patch output.
  905 </p>
  906 </dd>
  907 <dt class="hdlist1">
  908 <code>break_opt</code>, <code>detect_rename</code>, <code>rename-score</code>, <code>rename_limit</code>
  909 </dt>
  910 <dd>
  911 <p>
  912         Affects the way detection logic for complete rewrites, renames
  913         and copies.
  914 </p>
  915 </dd>
  916 <dt class="hdlist1">
  917 <code>abbrev</code>
  918 </dt>
  919 <dd>
  920 <p>
  921         Number of hexdigits to abbreviate raw format output to.
  922 </p>
  923 </dd>
  924 <dt class="hdlist1">
  925 <code>pickaxe</code>
  926 </dt>
  927 <dd>
  928 <p>
  929         A constant string (can and typically does contain newlines to
  930         look for a block of text, not just a single line) to filter out
  931         the filepairs that do not change the number of strings contained
  932         in its preimage and postimage of the diff_queue.
  933 </p>
  934 </dd>
  935 <dt class="hdlist1">
  936 <code>flags</code>
  937 </dt>
  938 <dd>
  939 <p>
  940         This is mostly a collection of boolean options that affects the
  941         operation, but some do not have anything to do with the diffcore
  942         library.
  943 </p>
  944 </dd>
  945 <dt class="hdlist1">
  946 <code>touched_flags</code>
  947 </dt>
  948 <dd>
  949 <p>
  950         Records whether a flag has been changed due to user request
  951         (rather than just set/unset by default).
  952 </p>
  953 </dd>
  954 <dt class="hdlist1">
  955 <code>set_default</code>
  956 </dt>
  957 <dd>
  958 <p>
  959         Callback which allows tweaking the options in diff_setup_done().
  960 </p>
  961 <div class="dlist"><dl>
  962 <dt class="hdlist1">
  963 BINARY, TEXT
  964 </dt>
  965 <dd>
  966 <p>
  967         Affects the way how a file that is seemingly binary is treated.
  968 </p>
  969 </dd>
  970 <dt class="hdlist1">
  971 FULL_INDEX
  972 </dt>
  973 <dd>
  974 <p>
  975         Tells the patch output format not to use abbreviated object
  976         names on the "index" lines.
  977 </p>
  978 </dd>
  979 <dt class="hdlist1">
  980 FIND_COPIES_HARDER
  981 </dt>
  982 <dd>
  983 <p>
  984         Tells the diffcore library that the caller is feeding unchanged
  985         filepairs to allow copies from unmodified files be detected.
  986 </p>
  987 </dd>
  988 <dt class="hdlist1">
  989 COLOR_DIFF
  990 </dt>
  991 <dd>
  992 <p>
  993         Output should be colored.
  994 </p>
  995 </dd>
  996 <dt class="hdlist1">
  997 COLOR_DIFF_WORDS
  998 </dt>
  999 <dd>
 1000 <p>
 1001         Output is a colored word-diff.
 1002 </p>
 1003 </dd>
 1004 <dt class="hdlist1">
 1005 NO_INDEX
 1006 </dt>
 1007 <dd>
 1008 <p>
 1009         Tells diff-files that the input is not tracked files but files
 1010         in random locations on the filesystem.
 1011 </p>
 1012 </dd>
 1013 <dt class="hdlist1">
 1014 ALLOW_EXTERNAL
 1015 </dt>
 1016 <dd>
 1017 <p>
 1018         Tells output routine that it is Ok to call user specified patch
 1019         output routine.  Plumbing disables this to ensure stable output.
 1020 </p>
 1021 </dd>
 1022 <dt class="hdlist1">
 1023 QUIET
 1024 </dt>
 1025 <dd>
 1026 <p>
 1027         Do not show any output.
 1028 </p>
 1029 </dd>
 1030 <dt class="hdlist1">
 1031 REVERSE_DIFF
 1032 </dt>
 1033 <dd>
 1034 <p>
 1035         Tells the library that the calling program is feeding the
 1036         filepairs reversed; <code>one</code> is two, and <code>two</code> is one.
 1037 </p>
 1038 </dd>
 1039 <dt class="hdlist1">
 1040 EXIT_WITH_STATUS
 1041 </dt>
 1042 <dd>
 1043 <p>
 1044         For communication between the calling program and the options
 1045         parser; tell the calling program to signal the presence of
 1046         difference using program exit code.
 1047 </p>
 1048 </dd>
 1049 <dt class="hdlist1">
 1050 HAS_CHANGES
 1051 </dt>
 1052 <dd>
 1053 <p>
 1054         Internal; used for optimization to see if there is any change.
 1055 </p>
 1056 </dd>
 1057 <dt class="hdlist1">
 1058 SILENT_ON_REMOVE
 1059 </dt>
 1060 <dd>
 1061 <p>
 1062         Affects if diff-files shows removed files.
 1063 </p>
 1064 </dd>
 1065 <dt class="hdlist1">
 1066 RECURSIVE, TREE_IN_RECURSIVE
 1067 </dt>
 1068 <dd>
 1069 <p>
 1070         Tells if tree traversal done by tree-diff should recursively
 1071         descend into a tree object pair that are different in preimage
 1072         and postimage set.
 1073 </p>
 1074 </dd>
 1075 </dl></div>
 1076 </dd>
 1077 </dl></div>
 1078 <div class="paragraph"><p>(JC)</p></div>
 1079 </div>
 1080 </div>
 1081 </div>
 1082 <div id="footnotes"><hr /></div>
 1083 <div id="footer">
 1084 <div id="footer-text">
 1085 Last updated
 1086  2018-12-15 13:23:56 JST
 1087 </div>
 1088 </div>
 1089 </body>
 1090 </html>