blob: 2bf3476eaa6ae5bbc612ab430856cdcd66052371 [file] [log] [blame]
Junio C Hamano3dac5042007-12-15 08:40:541<!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>
Junio C Hamano9d971152012-12-19 00:43:115<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:536<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano103b5722011-01-31 05:03:457<title>diff API</title>
Junio C Hamano3dac5042007-12-15 08:40:548<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:119/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano3dac5042007-12-15 08:40:5424}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamano4604fe52008-09-19 06:37:1030a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamano3dac5042007-12-15 08:40:5437
38em {
39 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:4540 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:5441}
42
43strong {
44 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:4545 color: #083194;
Junio C Hamano3dac5042007-12-15 08:40:5446}
47
Junio C Hamano3dac5042007-12-15 08:40:5448h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:5450 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamano4604fe52008-09-19 06:37:1055h1, h2, h3 {
Junio C Hamano3dac5042007-12-15 08:40:5456 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamano3dac5042007-12-15 08:40:5459 padding-top: 0.5em;
60}
Junio C Hamano4604fe52008-09-19 06:37:1061h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:1167h5 {
68 font-size: 1.0em;
69}
Junio C Hamano3dac5042007-12-15 08:40:5470
71div.sectionbody {
Junio C Hamano3dac5042007-12-15 08:40:5472 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
Junio C Hamano103b5722011-01-31 05:03:4584ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:1187ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano103b5722011-01-31 05:03:4589
Junio C Hamanoc14e6ad2014-10-31 20:25:5390.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:5494 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:5397pre {
98 white-space: pre-wrap;
99}
Junio C Hamano3dac5042007-12-15 08:40:54100
Junio C Hamano9d971152012-12-19 00:43:11101#author {
Junio C Hamano3dac5042007-12-15 08:40:54102 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54103 font-weight: bold;
Junio C Hamano4604fe52008-09-19 06:37:10104 font-size: 1.1em;
Junio C Hamano3dac5042007-12-15 08:40:54105}
Junio C Hamano9d971152012-12-19 00:43:11106#email {
Junio C Hamano3dac5042007-12-15 08:40:54107}
Junio C Hamano9d971152012-12-19 00:43:11108#revnumber, #revdate, #revremark {
Junio C Hamano3dac5042007-12-15 08:40:54109}
110
Junio C Hamano9d971152012-12-19 00:43:11111#footer {
Junio C Hamano3dac5042007-12-15 08:40:54112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11117#footer-text {
Junio C Hamano3dac5042007-12-15 08:40:54118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11121#footer-badges {
Junio C Hamano3dac5042007-12-15 08:40:54122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11126#preamble {
Junio C Hamano103b5722011-01-31 05:03:45127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano3dac5042007-12-15 08:40:54131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22133 margin-top: 1.0em;
Junio C Hamano3dac5042007-12-15 08:40:54134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
Junio C Hamano3dac5042007-12-15 08:40:54141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45149 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano3dac5042007-12-15 08:40:54173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano3dac5042007-12-15 08:40:54180 padding: 0.5em;
181}
182
Junio C Hamano7bd050f2011-09-22 06:32:22183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano3dac5042007-12-15 08:40:54189}
Junio C Hamano7bd050f2011-09-22 06:32:22190
Junio C Hamano103b5722011-01-31 05:03:45191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54193 text-align: right;
194}
Junio C Hamano103b5722011-01-31 05:03:45195
Junio C Hamano9d971152012-12-19 00:43:11196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano103b5722011-01-31 05:03:45199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano4604fe52008-09-19 06:37:10205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamano3dac5042007-12-15 08:40:54208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22219 border-left: 3px solid #dddddd;
Junio C Hamano3dac5042007-12-15 08:40:54220}
221
222div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54225}
226
Junio C Hamano3dac5042007-12-15 08:40:54227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano103b5722011-01-31 05:03:45229a.image:visited { color: white; }
Junio C Hamano3dac5042007-12-15 08:40:54230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45238 font-style: normal;
239 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54240}
241dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45242 margin-top: 0.1em;
Junio C Hamano3dac5042007-12-15 08:40:54243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano103b5722011-01-31 05:03:45248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamano3dac5042007-12-15 08:40:54252 list-style-type: lower-alpha;
253}
Junio C Hamano103b5722011-01-31 05:03:45254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
Junio C Hamano3dac5042007-12-15 08:40:54270
Junio C Hamano3dac5042007-12-15 08:40:54271tfoot {
272 font-weight: bold;
273}
Junio C Hamano103b5722011-01-31 05:03:45274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano103b5722011-01-31 05:03:45277
278div.hdlist {
Junio C Hamano3dac5042007-12-15 08:40:54279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano103b5722011-01-31 05:03:45282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamano4604fe52008-09-19 06:37:10284}
Junio C Hamano103b5722011-01-31 05:03:45285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamano3dac5042007-12-15 08:40:54289 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45290 font-style: normal;
Junio C Hamano3dac5042007-12-15 08:40:54291 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45292 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54293}
Junio C Hamano103b5722011-01-31 05:03:45294td.hdlist2 {
Junio C Hamano3dac5042007-12-15 08:40:54295 vertical-align: top;
296}
Junio C Hamano103b5722011-01-31 05:03:45297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamano3dac5042007-12-15 08:40:54305
Junio C Hamano7bd050f2011-09-22 06:32:22306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano3dac5042007-12-15 08:40:54340}
Junio C Hamano4604fe52008-09-19 06:37:10341
Junio C Hamano9d971152012-12-19 00:43:11342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11350#toctitle {
Junio C Hamano4604fe52008-09-19 06:37:10351 color: #527bbd;
Junio C Hamano4604fe52008-09-19 06:37:10352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano4604fe52008-09-19 06:37:10359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano3dac5042007-12-15 08:40:54374
Junio C Hamano9d971152012-12-19 00:43:11375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
Junio C Hamano3dac5042007-12-15 08:40:54427}
Junio C Hamano9d971152012-12-19 00:43:11428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
Junio C Hamano3dac5042007-12-15 08:40:54432 font-weight: bold;
Junio C Hamano9d971152012-12-19 00:43:11433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
Junio C Hamano3dac5042007-12-15 08:40:54449}
450
Junio C Hamano9d971152012-12-19 00:43:11451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54480}
481
Junio C Hamano9d971152012-12-19 00:43:11482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
Junio C Hamano103b5722011-01-31 05:03:45501 text-align: right;
502}
503
Junio C Hamano9d971152012-12-19 00:43:11504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45506}
Junio C Hamano9d971152012-12-19 00:43:11507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
Junio C Hamano3dac5042007-12-15 08:40:54512}
513
Junio C Hamano9d971152012-12-19 00:43:11514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
526body.manpage h2 {
527 border-style: none;
528}
529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano3dac5042007-12-15 08:40:54531}
Junio C Hamano4604fe52008-09-19 06:37:10532
Junio C Hamano9d971152012-12-19 00:43:11533@media print {
534 body.manpage div#toc { display: none; }
535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53536
537
Junio C Hamano3dac5042007-12-15 08:40:54538</style>
Junio C Hamano7bd050f2011-09-22 06:32:22539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano7bd050f2011-09-22 06:32:22682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11730asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22731/*]]>*/
732</script>
Junio C Hamano3dac5042007-12-15 08:40:54733</head>
Junio C Hamano9d971152012-12-19 00:43:11734<body class="article">
Junio C Hamano3dac5042007-12-15 08:40:54735<div id="header">
736<h1>diff API</h1>
737</div>
Junio C Hamano7bd050f2011-09-22 06:32:22738<div id="content">
Junio C Hamano3dac5042007-12-15 08:40:54739<div id="preamble">
740<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45741<div class="paragraph"><p>The diff API is for programs that compare two sets of files (e.g. two
Junio C Hamano3dac5042007-12-15 08:40:54742trees, one tree and the index) and present the found difference in
743various ways. The calling program is responsible for feeding the API
744pairs of files, one from the "old" set and the corresponding one from
745"new" set, that are different. The library called through this API is
Junio C Hamano4604fe52008-09-19 06:37:10746called diffcore, and is responsible for two things.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45747<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54748<li>
749<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53750finding total rewrites (<code>-B</code>), renames (<code>-M</code>) and copies (<code>-C</code>), and
751 changes that touch a string (<code>-S</code>), as specified by the caller.
Junio C Hamano3dac5042007-12-15 08:40:54752</p>
753</li>
754<li>
755<p>
756outputting the differences in various formats, as specified by the
757 caller.
758</p>
759</li>
Junio C Hamano4604fe52008-09-19 06:37:10760</ul></div>
Junio C Hamano3dac5042007-12-15 08:40:54761</div>
762</div>
Junio C Hamano9d971152012-12-19 00:43:11763<div class="sect1">
Junio C Hamano4604fe52008-09-19 06:37:10764<h2 id="_calling_sequence">Calling sequence</h2>
Junio C Hamano3dac5042007-12-15 08:40:54765<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45766<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54767<li>
768<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53769Prepare <code>struct diff_options</code> to record the set of diff options, and
770 then call <code>diff_setup()</code> to initialize this structure. This sets up
Junio C Hamano3dac5042007-12-15 08:40:54771 the vanilla default.
772</p>
773</li>
774<li>
775<p>
776Fill in the options structure to specify desired output format, rename
Junio C Hamanoc14e6ad2014-10-31 20:25:53777 detection, etc. <code>diff_opt_parse()</code> can be used to parse options given
Junio C Hamano3dac5042007-12-15 08:40:54778 from the command line in a way consistent with existing git-diff
779 family of programs.
780</p>
781</li>
782<li>
783<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53784Call <code>diff_setup_done()</code>; this inspects the options set up so far for
Junio C Hamano3dac5042007-12-15 08:40:54785 internal consistency and make necessary tweaking to it (e.g. if
Junio C Hamano238ce9c2013-10-23 21:56:38786 textual patch output was asked, recursive behaviour is turned on);
787 the callback set_default in diff_options can be used to tweak this more.
Junio C Hamano3dac5042007-12-15 08:40:54788</p>
789</li>
790<li>
791<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53792As you find different pairs of files, call <code>diff_change()</code> to feed
793 modified files, <code>diff_addremove()</code> to feed created or deleted files,
794 or <code>diff_unmerge()</code> to feed a file whose state is <em>unmerged</em> to the
795 API. These are thin wrappers to a lower-level <code>diff_queue()</code> function
Junio C Hamano3dac5042007-12-15 08:40:54796 that is flexible enough to record any of these kinds of changes.
797</p>
798</li>
799<li>
800<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53801Once you finish feeding the pairs of files, call <code>diffcore_std()</code>.
Junio C Hamano3dac5042007-12-15 08:40:54802 This will tell the diffcore library to go ahead and do its work.
803</p>
804</li>
805<li>
806<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53807Calling <code>diff_flush()</code> will produce the output.
Junio C Hamano3dac5042007-12-15 08:40:54808</p>
809</li>
Junio C Hamano4604fe52008-09-19 06:37:10810</ul></div>
Junio C Hamano3dac5042007-12-15 08:40:54811</div>
Junio C Hamano9d971152012-12-19 00:43:11812</div>
813<div class="sect1">
Junio C Hamano4604fe52008-09-19 06:37:10814<h2 id="_data_structures">Data structures</h2>
Junio C Hamano3dac5042007-12-15 08:40:54815<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45816<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54817<li>
818<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53819<code>struct diff_filespec</code>
Junio C Hamano3dac5042007-12-15 08:40:54820</p>
821</li>
Junio C Hamano4604fe52008-09-19 06:37:10822</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45823<div class="paragraph"><p>This is the internal representation for a single file (blob). It
824records the blob object name (if known&#8201;&#8212;&#8201;for a work tree file it
Junio C Hamano3dac5042007-12-15 08:40:54825typically is a NUL SHA-1), filemode and pathname. This is what the
Junio C Hamanoc14e6ad2014-10-31 20:25:53826<code>diff_addremove()</code>, <code>diff_change()</code> and <code>diff_unmerge()</code> synthesize and
827feed <code>diff_queue()</code> function with.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45828<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54829<li>
830<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53831<code>struct diff_filepair</code>
Junio C Hamano3dac5042007-12-15 08:40:54832</p>
833</li>
Junio C Hamano4604fe52008-09-19 06:37:10834</ul></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53835<div class="paragraph"><p>This records a pair of <code>struct diff_filespec</code>; the filespec for a file
836in the "old" set (i.e. preimage) is called <code>one</code>, and the filespec for a
837file in the "new" set (i.e. postimage) is called <code>two</code>. A change that
838represents file creation has NULL in <code>one</code>, and file deletion has NULL
839in <code>two</code>.</p></div>
840<div class="paragraph"><p>A <code>filepair</code> starts pointing at <code>one</code> and <code>two</code> that are from the same
841filename, but <code>diffcore_std()</code> can break pairs and match component
Junio C Hamano3dac5042007-12-15 08:40:54842filespecs with other filespecs from a different filepair to form new
Junio C Hamano4604fe52008-09-19 06:37:10843filepair. This is called <em>rename detection</em>.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45844<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54845<li>
846<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53847<code>struct diff_queue</code>
Junio C Hamano3dac5042007-12-15 08:40:54848</p>
849</li>
Junio C Hamano4604fe52008-09-19 06:37:10850</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45851<div class="paragraph"><p>This is a collection of filepairs. Notable members are:</p></div>
852<div class="dlist"><dl>
853<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53854<code>queue</code>
Junio C Hamano3dac5042007-12-15 08:40:54855</dt>
856<dd>
857<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53858 An array of pointers to <code>struct diff_filepair</code>. This
Junio C Hamano3dac5042007-12-15 08:40:54859 dynamically grows as you add filepairs;
860</p>
861</dd>
Junio C Hamano103b5722011-01-31 05:03:45862<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53863<code>alloc</code>
Junio C Hamano3dac5042007-12-15 08:40:54864</dt>
865<dd>
866<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53867 The allocated size of the <code>queue</code> array;
Junio C Hamano3dac5042007-12-15 08:40:54868</p>
869</dd>
Junio C Hamano103b5722011-01-31 05:03:45870<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53871<code>nr</code>
Junio C Hamano3dac5042007-12-15 08:40:54872</dt>
873<dd>
874<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53875 The number of elements in the <code>queue</code> array.
Junio C Hamano3dac5042007-12-15 08:40:54876</p>
Junio C Hamano103b5722011-01-31 05:03:45877<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54878<li>
879<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53880<code>struct diff_options</code>
Junio C Hamano3dac5042007-12-15 08:40:54881</p>
882</li>
Junio C Hamano4604fe52008-09-19 06:37:10883</ul></div>
Junio C Hamano3dac5042007-12-15 08:40:54884</dd>
Junio C Hamano4604fe52008-09-19 06:37:10885</dl></div>
Junio C Hamano103b5722011-01-31 05:03:45886<div class="paragraph"><p>This describes the set of options the calling program wants to affect
Junio C Hamano4604fe52008-09-19 06:37:10887the operation of diffcore library with.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45888<div class="paragraph"><p>Notable members are:</p></div>
889<div class="dlist"><dl>
890<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53891<code>output_format</code>
Junio C Hamano3dac5042007-12-15 08:40:54892</dt>
893<dd>
894<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53895 The output format used when <code>diff_flush()</code> is run.
Junio C Hamano3dac5042007-12-15 08:40:54896</p>
897</dd>
Junio C Hamano103b5722011-01-31 05:03:45898<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53899<code>context</code>
Junio C Hamano3dac5042007-12-15 08:40:54900</dt>
901<dd>
902<p>
903 Number of context lines to generate in patch output.
904</p>
905</dd>
Junio C Hamano103b5722011-01-31 05:03:45906<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53907<code>break_opt</code>, <code>detect_rename</code>, <code>rename-score</code>, <code>rename_limit</code>
Junio C Hamano3dac5042007-12-15 08:40:54908</dt>
909<dd>
910<p>
911 Affects the way detection logic for complete rewrites, renames
912 and copies.
913</p>
914</dd>
Junio C Hamano103b5722011-01-31 05:03:45915<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53916<code>abbrev</code>
Junio C Hamano3dac5042007-12-15 08:40:54917</dt>
918<dd>
919<p>
Junio C Hamano4e272312008-01-08 09:13:21920 Number of hexdigits to abbreviate raw format output to.
Junio C Hamano3dac5042007-12-15 08:40:54921</p>
922</dd>
Junio C Hamano103b5722011-01-31 05:03:45923<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53924<code>pickaxe</code>
Junio C Hamano3dac5042007-12-15 08:40:54925</dt>
926<dd>
927<p>
928 A constant string (can and typically does contain newlines to
929 look for a block of text, not just a single line) to filter out
930 the filepairs that do not change the number of strings contained
Junio C Hamano4e272312008-01-08 09:13:21931 in its preimage and postimage of the diff_queue.
Junio C Hamano3dac5042007-12-15 08:40:54932</p>
933</dd>
Junio C Hamano103b5722011-01-31 05:03:45934<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53935<code>flags</code>
Junio C Hamano3dac5042007-12-15 08:40:54936</dt>
937<dd>
938<p>
939 This is mostly a collection of boolean options that affects the
940 operation, but some do not have anything to do with the diffcore
941 library.
942</p>
Junio C Hamano238ce9c2013-10-23 21:56:38943</dd>
944<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53945<code>touched_flags</code>
Junio C Hamano238ce9c2013-10-23 21:56:38946</dt>
947<dd>
948<p>
949 Records whether a flag has been changed due to user request
950 (rather than just set/unset by default).
951</p>
952</dd>
953<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53954<code>set_default</code>
Junio C Hamano238ce9c2013-10-23 21:56:38955</dt>
956<dd>
957<p>
958 Callback which allows tweaking the options in diff_setup_done().
959</p>
Junio C Hamano103b5722011-01-31 05:03:45960<div class="dlist"><dl>
961<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54962BINARY, TEXT
963</dt>
964<dd>
965<p>
966 Affects the way how a file that is seemingly binary is treated.
967</p>
968</dd>
Junio C Hamano103b5722011-01-31 05:03:45969<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54970FULL_INDEX
971</dt>
972<dd>
973<p>
974 Tells the patch output format not to use abbreviated object
975 names on the "index" lines.
976</p>
977</dd>
Junio C Hamano103b5722011-01-31 05:03:45978<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54979FIND_COPIES_HARDER
980</dt>
981<dd>
982<p>
983 Tells the diffcore library that the caller is feeding unchanged
984 filepairs to allow copies from unmodified files be detected.
985</p>
986</dd>
Junio C Hamano103b5722011-01-31 05:03:45987<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54988COLOR_DIFF
989</dt>
990<dd>
991<p>
992 Output should be colored.
993</p>
994</dd>
Junio C Hamano103b5722011-01-31 05:03:45995<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:54996COLOR_DIFF_WORDS
997</dt>
998<dd>
999<p>
1000 Output is a colored word-diff.
1001</p>
1002</dd>
Junio C Hamano103b5722011-01-31 05:03:451003<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:541004NO_INDEX
1005</dt>
1006<dd>
1007<p>
1008 Tells diff-files that the input is not tracked files but files
1009 in random locations on the filesystem.
1010</p>
1011</dd>
Junio C Hamano103b5722011-01-31 05:03:451012<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:541013ALLOW_EXTERNAL
1014</dt>
1015<dd>
1016<p>
1017 Tells output routine that it is Ok to call user specified patch
1018 output routine. Plumbing disables this to ensure stable output.
1019</p>
1020</dd>
Junio C Hamano103b5722011-01-31 05:03:451021<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:541022QUIET
1023</dt>
1024<dd>
1025<p>
1026 Do not show any output.
1027</p>
1028</dd>
Junio C Hamano103b5722011-01-31 05:03:451029<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:541030REVERSE_DIFF
1031</dt>
1032<dd>
1033<p>
1034 Tells the library that the calling program is feeding the
Junio C Hamanoc14e6ad2014-10-31 20:25:531035 filepairs reversed; <code>one</code> is two, and <code>two</code> is one.
Junio C Hamano3dac5042007-12-15 08:40:541036</p>
1037</dd>
Junio C Hamano103b5722011-01-31 05:03:451038<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:541039EXIT_WITH_STATUS
1040</dt>
1041<dd>
1042<p>
1043 For communication between the calling program and the options
Junio C Hamano4e272312008-01-08 09:13:211044 parser; tell the calling program to signal the presence of
Junio C Hamano3dac5042007-12-15 08:40:541045 difference using program exit code.
1046</p>
1047</dd>
Junio C Hamano103b5722011-01-31 05:03:451048<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:541049HAS_CHANGES
1050</dt>
1051<dd>
1052<p>
1053 Internal; used for optimization to see if there is any change.
1054</p>
1055</dd>
Junio C Hamano103b5722011-01-31 05:03:451056<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:541057SILENT_ON_REMOVE
1058</dt>
1059<dd>
1060<p>
1061 Affects if diff-files shows removed files.
1062</p>
1063</dd>
Junio C Hamano103b5722011-01-31 05:03:451064<dt class="hdlist1">
Junio C Hamano3dac5042007-12-15 08:40:541065RECURSIVE, TREE_IN_RECURSIVE
1066</dt>
1067<dd>
1068<p>
1069 Tells if tree traversal done by tree-diff should recursively
1070 descend into a tree object pair that are different in preimage
1071 and postimage set.
1072</p>
1073</dd>
Junio C Hamano4604fe52008-09-19 06:37:101074</dl></div>
Junio C Hamano3dac5042007-12-15 08:40:541075</dd>
Junio C Hamano4604fe52008-09-19 06:37:101076</dl></div>
Junio C Hamano103b5722011-01-31 05:03:451077<div class="paragraph"><p>(JC)</p></div>
Junio C Hamano3dac5042007-12-15 08:40:541078</div>
Junio C Hamano7bd050f2011-09-22 06:32:221079</div>
Junio C Hamano9d971152012-12-19 00:43:111080</div>
Junio C Hamano7bd050f2011-09-22 06:32:221081<div id="footnotes"><hr /></div>
Junio C Hamano3dac5042007-12-15 08:40:541082<div id="footer">
1083<div id="footer-text">
Junio C Hamano238ce9c2013-10-23 21:56:381084Last updated 2013-10-23 14:56:14 PDT
Junio C Hamano3dac5042007-12-15 08:40:541085</div>
1086</div>
1087</body>
1088</html>