Google Git
Sign in
chromium / external / gitster / git-htmldocs / bcd98f41a1bf21a71ee80e4b1f381e1290909b66 / . / technical / index-format.html
blob: 53872f66c1d7cecd9c1d748c739a915710d3fdf8 [file] [log] [blame]
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]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>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]5<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]6<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]7<title>Git index format</title>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]8<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]9/* 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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]24}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
37
38em {
39 font-style: italic;
40 color: navy;
41}
42
43strong {
44 font-weight: bold;
45 color: #083194;
46}
47
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
55h1, h2, h3 {
56 border-bottom: 2px solid silver;
57}
58h2 {
59 padding-top: 0.5em;
60}
61h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]67h5 {
68 font-size: 1.0em;
69}
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]70
71div.sectionbody {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]72 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
84ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]87ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]89
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]94 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]97pre {
98 white-space: pre-wrap;
99}
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]100
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]101#author {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]102 color: #527bbd;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]103 font-weight: bold;
104 font-size: 1.1em;
105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#email {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]107}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]108#revnumber, #revdate, #revremark {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]109}
110
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]111#footer {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]112 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:11[diff] [blame]117#footer-text {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]121#footer-badges {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]126#preamble {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
133 margin-top: 1.0em;
134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
149 color: #527bbd;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]150 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:11[diff] [blame]171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]180 padding: 0.5em;
181}
182
183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]189}
190
191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
193 text-align: right;
194}
195
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]199}
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. */
205div.verseblock + div.attribution {
206 text-align: left;
207}
208
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;
219 border-left: 3px solid #dddddd;
220}
221
222div.exampleblock > div.content {
223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
225}
226
227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]229a.image:visited { color: white; }
230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
238 font-style: normal;
239 color: navy;
240}
241dd > *:first-child {
242 margin-top: 0.1em;
243}
244
245ul, ol {
246 list-style-position: outside;
247}
248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
252 list-style-type: lower-alpha;
253}
254ol.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}
270
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]271tfoot {
272 font-weight: bold;
273}
274td > div.verse {
275 white-space: pre;
276}
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]277
278div.hdlist {
279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
282div.hdlist tr {
283 padding-bottom: 15px;
284}
285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
289 vertical-align: top;
290 font-style: normal;
291 padding-right: 0.8em;
292 color: navy;
293}
294td.hdlist2 {
295 vertical-align: top;
296}
297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
305
306.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:11[diff] [blame]333div.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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]340}
341
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]350#toctitle {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]351 color: #527bbd;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]352 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:53[diff] [blame]358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]359 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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]374
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375span.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:53[diff] [blame]416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]427}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]432 font-weight: bold;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]433 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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]449}
450
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]451
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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]480}
481
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]482table.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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]501 text-align: right;
502}
503
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]506}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]507th.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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]512}
513
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]514
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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]531}
532
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]533@media print {
534 body.manpage div#toc { display: none; }
535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]536
537
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]538</style>
539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]541var 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:53[diff] [blame]582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]583 // 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:11[diff] [blame]602 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:53[diff] [blame]611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]612 && 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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]621 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:11[diff] [blame]648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]651 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:53[diff] [blame]657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]658 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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]666 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:11[diff] [blame]672 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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]682 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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]686 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:11[diff] [blame]705},
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 Hamanof2b74942012-11-20 21:06:26[diff] [blame]727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]730asciidoc.install();
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]731/*]]>*/
732</script>
733</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]734<body class="article">
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]735<div id="header">
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]736<h1>Git index format</h1>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]737</div>
738<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]739<div class="sect1">
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]740<h2 id="_the_git_index_file_has_the_following_format">The Git index file has the following format</h2>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]741<div class="sectionbody">
742<div class="literalblock">
743<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]744<pre><code>All binary numbers are in network byte order. Version 2 is described
745here unless stated otherwise.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]746</div></div>
747<div class="ulist"><ul>
748<li>
749<p>
750A 12-byte header consisting of
751</p>
752<div class="literalblock">
753<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]754<pre><code>4-byte signature:
755 The signature is { 'D', 'I', 'R', 'C' } (stands for "dircache")</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]756</div></div>
757<div class="literalblock">
758<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]759<pre><code>4-byte version number:
760 The current supported versions are 2, 3 and 4.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]761</div></div>
762<div class="literalblock">
763<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]764<pre><code>32-bit number of index entries.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]765</div></div>
766</li>
767<li>
768<p>
769A number of sorted index entries (see below).
770</p>
771</li>
772<li>
773<p>
774Extensions
775</p>
776<div class="literalblock">
777<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]778<pre><code>Extensions are identified by signature. Optional extensions can
779be ignored if Git does not understand them.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]780</div></div>
781<div class="literalblock">
782<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]783<pre><code>Git currently supports cached tree and resolve undo extensions.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]784</div></div>
785<div class="literalblock">
786<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]787<pre><code>4-byte extension signature. If the first byte is 'A'..'Z' the
788extension is optional and can be ignored.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]789</div></div>
790<div class="literalblock">
791<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]792<pre><code>32-bit size of the extension</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]793</div></div>
794<div class="literalblock">
795<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]796<pre><code>Extension data</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]797</div></div>
798</li>
799<li>
800<p>
801160-bit SHA-1 over the content of the index file before this
802 checksum.
803</p>
804</li>
805</ul></div>
806</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]807</div>
808<div class="sect1">
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]809<h2 id="_index_entry">Index entry</h2>
810<div class="sectionbody">
811<div class="literalblock">
812<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]813<pre><code>Index entries are sorted in ascending order on the name field,
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]814interpreted as a string of unsigned bytes (i.e. memcmp() order, no
815localization, no special casing of directory separator '/'). Entries
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]816with the same name are sorted by their stage field.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]817</div></div>
818<div class="literalblock">
819<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]820<pre><code>32-bit ctime seconds, the last time a file's metadata changed
821 this is stat(2) data</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]822</div></div>
823<div class="literalblock">
824<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]825<pre><code>32-bit ctime nanosecond fractions
826 this is stat(2) data</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]827</div></div>
828<div class="literalblock">
829<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]830<pre><code>32-bit mtime seconds, the last time a file's data changed
831 this is stat(2) data</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]832</div></div>
833<div class="literalblock">
834<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]835<pre><code>32-bit mtime nanosecond fractions
836 this is stat(2) data</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]837</div></div>
838<div class="literalblock">
839<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]840<pre><code>32-bit dev
841 this is stat(2) data</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]842</div></div>
843<div class="literalblock">
844<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]845<pre><code>32-bit ino
846 this is stat(2) data</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]847</div></div>
848<div class="literalblock">
849<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]850<pre><code>32-bit mode, split into (high to low bits)</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]851</div></div>
852<div class="literalblock">
853<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]854<pre><code>4-bit object type
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]855 valid values in binary are 1000 (regular file), 1010 (symbolic link)
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]856 and 1110 (gitlink)</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]857</div></div>
858<div class="literalblock">
859<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]860<pre><code>3-bit unused</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]861</div></div>
862<div class="literalblock">
863<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]864<pre><code>9-bit unix permission. Only 0755 and 0644 are valid for regular files.
865Symbolic links and gitlinks have value 0 in this field.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]866</div></div>
867<div class="literalblock">
868<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]869<pre><code>32-bit uid
870 this is stat(2) data</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]871</div></div>
872<div class="literalblock">
873<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]874<pre><code>32-bit gid
875 this is stat(2) data</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]876</div></div>
877<div class="literalblock">
878<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]879<pre><code>32-bit file size
880 This is the on-disk size from stat(2), truncated to 32-bit.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]881</div></div>
882<div class="literalblock">
883<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]884<pre><code>160-bit SHA-1 for the represented object</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]885</div></div>
886<div class="literalblock">
887<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]888<pre><code>A 16-bit 'flags' field split into (high to low bits)</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]889</div></div>
890<div class="literalblock">
891<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]892<pre><code>1-bit assume-valid flag</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]893</div></div>
894<div class="literalblock">
895<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]896<pre><code>1-bit extended flag (must be zero in version 2)</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]897</div></div>
898<div class="literalblock">
899<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]900<pre><code>2-bit stage (during merge)</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]901</div></div>
902<div class="literalblock">
903<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]904<pre><code>12-bit name length if the length is less than 0xFFF; otherwise 0xFFF
905is stored in this field.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]906</div></div>
907<div class="literalblock">
908<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]909<pre><code>(Version 3 or later) A 16-bit field, only applicable if the
910"extended flag" above is 1, split into (high to low bits).</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]911</div></div>
912<div class="literalblock">
913<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]914<pre><code>1-bit reserved for future</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]915</div></div>
916<div class="literalblock">
917<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]918<pre><code>1-bit skip-worktree flag (used by sparse checkout)</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]919</div></div>
920<div class="literalblock">
921<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]922<pre><code>1-bit intent-to-add flag (used by "git add -N")</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]923</div></div>
924<div class="literalblock">
925<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]926<pre><code>13-bit unused, must be zero</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]927</div></div>
928<div class="literalblock">
929<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]930<pre><code>Entry path name (variable length) relative to top level directory
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]931 (without leading slash). '/' is used as path separator. The special
932 path components ".", ".." and ".git" (without quotes) are disallowed.
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]933 Trailing slash is also disallowed.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]934</div></div>
935<div class="literalblock">
936<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]937<pre><code>The exact encoding is undefined, but the '.' and '/' characters
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]938are encoded in 7-bit ASCII and the encoding cannot contain a NUL
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]939byte (iow, this is a UNIX pathname).</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]940</div></div>
941<div class="literalblock">
942<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]943<pre><code>(Version 4) In version 4, the entry path name is prefix-compressed
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]944 relative to the path name for the previous entry (the very first
945 entry is encoded as if the path name for the previous entry is an
946 empty string). At the beginning of an entry, an integer N in the
947 variable width encoding (the same encoding as the offset is encoded
948 for OFS_DELTA pack entries; see pack-format.txt) is stored, followed
949 by a NUL-terminated string S. Removing N bytes from the end of the
950 path name for the previous entry, and replacing it with the string S
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]951 yields the path name for this entry.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]952</div></div>
953<div class="literalblock">
954<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]955<pre><code>1-8 nul bytes as necessary to pad the entry to a multiple of eight bytes
956while keeping the name NUL-terminated.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]957</div></div>
958<div class="literalblock">
959<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]960<pre><code>(Version 4) In version 4, the padding after the pathname does not
961exist.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]962</div></div>
Junio C Hamano6f0c9442014-07-16 21:51:32[diff] [blame]963<div class="literalblock">
964<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]965<pre><code>Interpretation of index entries in split index mode is completely
966different. See below for details.</code></pre>
Junio C Hamano6f0c9442014-07-16 21:51:32[diff] [blame]967</div></div>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]968</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]969</div>
970<div class="sect1">
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]971<h2 id="_extensions">Extensions</h2>
972<div class="sectionbody">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]973<div class="sect2">
974<h3 id="_cached_tree">Cached tree</h3>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]975<div class="literalblock">
976<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]977<pre><code>Cached tree extension contains pre-computed hashes for trees that can
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]978be derived from the index. It helps speed up tree object generation
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]979from index for a new commit.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]980</div></div>
981<div class="literalblock">
982<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]983<pre><code>When a path is updated in index, the path must be invalidated and
984removed from tree cache.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]985</div></div>
986<div class="literalblock">
987<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]988<pre><code>The signature for this extension is { 'T', 'R', 'E', 'E' }.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]989</div></div>
990<div class="literalblock">
991<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]992<pre><code>A series of entries fill the entire extension; each of which
993consists of:</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]994</div></div>
995<div class="ulist"><ul>
996<li>
997<p>
998NUL-terminated path component (relative to its parent directory);
999</p>
1000</li>
1001<li>
1002<p>
1003ASCII decimal number of entries in the index that is covered by the
1004 tree this entry represents (entry_count);
1005</p>
1006</li>
1007<li>
1008<p>
1009A space (ASCII 32);
1010</p>
1011</li>
1012<li>
1013<p>
1014ASCII decimal number that represents the number of subtrees this
1015 tree has;
1016</p>
1017</li>
1018<li>
1019<p>
1020A newline (ASCII 10); and
1021</p>
1022</li>
1023<li>
1024<p>
1025160-bit object name for the object that would result from writing
1026 this span of index as a tree.
1027</p>
1028<div class="literalblock">
1029<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1030<pre><code>An entry can be in an invalidated state and is represented by having
Junio C Hamanodb81b992012-12-21 23:49:12[diff] [blame]1031a negative number in the entry_count field. In this case, there is no
1032object name and the next entry starts immediately after the newline.
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1033When writing an invalid entry, -1 should always be used as entry_count.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1034</div></div>
1035<div class="literalblock">
1036<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1037<pre><code>The entries are written out in the top-down, depth-first order. The
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1038first entry represents the root level of the repository, followed by the
Junio C Hamanoee615802015-10-29 21:45:26[diff] [blame]1039first subtree--let's call this A--of the root level (with its name
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1040relative to the root level), followed by the first subtree of A (with
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1041its name relative to A), ...</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1042</div></div>
1043</li>
1044</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1045</div>
1046<div class="sect2">
1047<h3 id="_resolve_undo">Resolve undo</h3>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1048<div class="literalblock">
1049<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1050<pre><code>A conflict is represented in the index as a set of higher stage entries.
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1051When a conflict is resolved (e.g. with "git add path"), these higher
Junio C Hamanod7fccbf2013-07-25 03:24:57[diff] [blame]1052stage entries will be removed and a stage-0 entry with proper resolution
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1053is added.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1054</div></div>
1055<div class="literalblock">
1056<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1057<pre><code>When these higher stage entries are removed, they are saved in the
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1058resolve undo extension, so that conflicts can be recreated (e.g. with
1059"git checkout -m"), in case users want to redo a conflict resolution
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1060from scratch.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1061</div></div>
1062<div class="literalblock">
1063<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1064<pre><code>The signature for this extension is { 'R', 'E', 'U', 'C' }.</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1065</div></div>
1066<div class="literalblock">
1067<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1068<pre><code>A series of entries fill the entire extension; each of which
1069consists of:</code></pre>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1070</div></div>
1071<div class="ulist"><ul>
1072<li>
1073<p>
1074NUL-terminated pathname the entry describes (relative to the root of
1075 the repository, i.e. full pathname);
1076</p>
1077</li>
1078<li>
1079<p>
1080Three NUL-terminated ASCII octal numbers, entry mode of entries in
1081 stage 1 to 3 (a missing stage is represented by "0" in this field);
1082 and
1083</p>
1084</li>
1085<li>
1086<p>
1087At most three 160-bit object names of the entry in stages from 1 to 3
1088 (nothing is written for a missing stage).
1089</p>
1090</li>
1091</ul></div>
1092</div>
Junio C Hamano6f0c9442014-07-16 21:51:32[diff] [blame]1093<div class="sect2">
1094<h3 id="_split_index">Split index</h3>
1095<div class="literalblock">
1096<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1097<pre><code>In split index mode, the majority of index entries could be stored
Junio C Hamano6f0c9442014-07-16 21:51:32[diff] [blame]1098in a separate file. This extension records the changes to be made on
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1099top of that to produce the final index.</code></pre>
Junio C Hamano6f0c9442014-07-16 21:51:32[diff] [blame]1100</div></div>
1101<div class="literalblock">
1102<div class="content">
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]1103<pre><code>The signature for this extension is { 'l', 'i', 'n', 'k' }.</code></pre>
Junio C Hamano6f0c9442014-07-16 21:51:32[diff] [blame]1104</div></div>
1105<div class="literalblock">
1106<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1107<pre><code>The extension consists of:</code></pre>
Junio C Hamano6f0c9442014-07-16 21:51:32[diff] [blame]1108</div></div>
1109<div class="ulist"><ul>
1110<li>
1111<p>
1112160-bit SHA-1 of the shared index file. The shared index file path
1113 is $GIT_DIR/sharedindex.&lt;SHA-1&gt;. If all 160 bits are zero, the
1114 index does not require a shared index file.
1115</p>
1116</li>
1117<li>
1118<p>
1119An ewah-encoded delete bitmap, each bit represents an entry in the
1120 shared index. If a bit is set, its corresponding entry in the
1121 shared index will be removed from the final index. Note, because
1122 a delete operation changes index entry positions, but we do need
1123 original positions in replace phase, it&#8217;s best to just mark
1124 entries for removal, then do a mass deletion after replacement.
1125</p>
1126</li>
1127<li>
1128<p>
1129An ewah-encoded replace bitmap, each bit represents an entry in
1130 the shared index. If a bit is set, its corresponding entry in the
1131 shared index will be replaced with an entry in this index
1132 file. All replaced entries are stored in sorted order in this
1133 index. The first "1" bit in the replace bitmap corresponds to the
1134 first index entry, the second "1" bit to the second entry and so
1135 on. Replaced entries may have empty path names to save space.
1136</p>
1137<div class="literalblock">
1138<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1139<pre><code>The remaining index entries after replaced ones will be added to the
Junio C Hamanofb5ffde2014-11-04 22:38:56[diff] [blame]1140final index. These added entries are also sorted by entry name then
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1141stage.</code></pre>
Junio C Hamano6f0c9442014-07-16 21:51:32[diff] [blame]1142</div></div>
1143</li>
1144</ul></div>
1145</div>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1146</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1147</div>
Junio C Hamanoc4e2a202015-05-26 21:38:47[diff] [blame]1148<div class="sect1">
1149<h2 id="_untracked_cache">Untracked cache</h2>
1150<div class="sectionbody">
1151<div class="literalblock">
1152<div class="content">
1153<pre><code>Untracked cache saves the untracked file list and necessary data to
1154verify the cache. The signature for this extension is { 'U', 'N',
1155'T', 'R' }.</code></pre>
1156</div></div>
1157<div class="literalblock">
1158<div class="content">
1159<pre><code>The extension starts with</code></pre>
1160</div></div>
1161<div class="ulist"><ul>
1162<li>
1163<p>
1164A sequence of NUL-terminated strings, preceded by the size of the
1165 sequence in variable width encoding. Each string describes the
1166 environment where the cache can be used.
1167</p>
1168</li>
1169<li>
1170<p>
1171Stat data of $GIT_DIR/info/exclude. See "Index entry" section from
1172 ctime field until "file size".
1173</p>
1174</li>
1175<li>
1176<p>
1177Stat data of core.excludesfile
1178</p>
1179</li>
1180<li>
1181<p>
118232-bit dir_flags (see struct dir_struct)
1183</p>
1184</li>
1185<li>
1186<p>
1187160-bit SHA-1 of $GIT_DIR/info/exclude. Null SHA-1 means the file
1188 does not exist.
1189</p>
1190</li>
1191<li>
1192<p>
1193160-bit SHA-1 of core.excludesfile. Null SHA-1 means the file does
1194 not exist.
1195</p>
1196</li>
1197<li>
1198<p>
1199NUL-terminated string of per-dir exclude file name. This usually
1200 is ".gitignore".
1201</p>
1202</li>
1203<li>
1204<p>
1205The number of following directory blocks, variable width
1206 encoding. If this number is zero, the extension ends here with a
1207 following NUL.
1208</p>
1209</li>
1210<li>
1211<p>
1212A number of directory blocks in depth-first-search order, each
1213 consists of
1214</p>
1215</li>
1216<li>
1217<p>
1218The number of untracked entries, variable width encoding.
1219</p>
1220</li>
1221<li>
1222<p>
1223The number of sub-directory blocks, variable width encoding.
1224</p>
1225</li>
1226<li>
1227<p>
1228The directory name terminated by NUL.
1229</p>
1230</li>
1231<li>
1232<p>
Junio C Hamanob6aa12e2015-08-19 22:40:17[diff] [blame]1233A number of untracked file/dir names terminated by NUL.
Junio C Hamanoc4e2a202015-05-26 21:38:47[diff] [blame]1234</p>
1235</li>
1236</ul></div>
1237<div class="paragraph"><p>The remaining data of each directory block is grouped by type:</p></div>
1238<div class="ulist"><ul>
1239<li>
1240<p>
1241An ewah bitmap, the n-th bit marks whether the n-th directory has
1242 valid untracked cache entries.
1243</p>
1244</li>
1245<li>
1246<p>
1247An ewah bitmap, the n-th bit records "check-only" bit of
1248 read_directory_recursive() for the n-th directory.
1249</p>
1250</li>
1251<li>
1252<p>
1253An ewah bitmap, the n-th bit indicates whether SHA-1 and stat data
1254 is valid for the n-th directory and exists in the next data.
1255</p>
1256</li>
1257<li>
1258<p>
1259An array of stat data. The n-th data corresponds with the n-th
1260 "one" bit in the previous ewah bitmap.
1261</p>
1262</li>
1263<li>
1264<p>
1265An array of SHA-1. The n-th SHA-1 corresponds with the n-th "one" bit
1266 in the previous ewah bitmap.
1267</p>
1268</li>
1269<li>
1270<p>
1271One NUL.
1272</p>
1273</li>
1274</ul></div>
1275</div>
1276</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1277</div>
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1278<div id="footnotes"><hr /></div>
1279<div id="footer">
1280<div id="footer-text">
Junio C Hamanoee615802015-10-29 21:45:26[diff] [blame]1281Last updated 2015-10-29 14:44:28 PDT
Junio C Hamanof2b74942012-11-20 21:06:26[diff] [blame]1282</div>
1283</div>
1284</body>
1285</html>