| blob | 5a1731ddb524bdde21c50523bbe42dd8e74531ba |
1 '\" t
2 .\" Title: gitformat-index
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 09/23/2022
6 .\" Manual: Git Manual
7 .\" Source: Git 2.38.0.rc1.6.g4fd6c5e444
8 .\" Language: English
9 .\"
10 .TH "GITFORMAT\-INDEX" "5" "09/23/2022" "Git 2\&.38\&.0\&.rc1\&.6\&.g4f" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 gitformat-index \- Git index format
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 $GIT_DIR/index
36 .fi
37 .sp
38 .SH "DESCRIPTION"
39 .sp
40 Git index format
41 .SH "THE GIT INDEX FILE HAS THE FOLLOWING FORMAT"
42 .sp
43 .if n \{\
44 .RS 4
45 .\}
46 .nf
47 All binary numbers are in network byte order\&.
48 In a repository using the traditional SHA\-1, checksums and object IDs
49 (object names) mentioned below are all computed using SHA\-1\&. Similarly,
50 in SHA\-256 repositories, these values are computed using SHA\-256\&.
51 Version 2 is described here unless stated otherwise\&.
52 .fi
53 .if n \{\
54 .RE
55 .\}
56 .sp
57 .RS 4
58 .ie n \{\
59 \h'-04'\(bu\h'+03'\c
60 .\}
61 .el \{\
62 .sp -1
63 .IP \(bu 2.3
64 .\}
65 A 12\-byte header consisting of
66 .sp
67 .if n \{\
68 .RS 4
69 .\}
70 .nf
71 4\-byte signature:
72 The signature is { \(aqD\(aq, \(aqI\(aq, \(aqR\(aq, \(aqC\(aq } (stands for "dircache")
73 .fi
74 .if n \{\
75 .RE
76 .\}
77 .sp
78 .if n \{\
79 .RS 4
80 .\}
81 .nf
82 4\-byte version number:
83 The current supported versions are 2, 3 and 4\&.
84 .fi
85 .if n \{\
86 .RE
87 .\}
88 .sp
89 .if n \{\
90 .RS 4
91 .\}
92 .nf
93 32\-bit number of index entries\&.
94 .fi
95 .if n \{\
96 .RE
97 .\}
98 .RE
99 .sp
100 .RS 4
101 .ie n \{\
102 \h'-04'\(bu\h'+03'\c
103 .\}
104 .el \{\
105 .sp -1
106 .IP \(bu 2.3
107 .\}
108 A number of sorted index entries (see below)\&.
109 .RE
110 .sp
111 .RS 4
112 .ie n \{\
113 \h'-04'\(bu\h'+03'\c
114 .\}
115 .el \{\
116 .sp -1
117 .IP \(bu 2.3
118 .\}
119 Extensions
120 .sp
121 .if n \{\
122 .RS 4
123 .\}
124 .nf
125 Extensions are identified by signature\&. Optional extensions can
126 be ignored if Git does not understand them\&.
127 .fi
128 .if n \{\
129 .RE
130 .\}
131 .sp
132 .if n \{\
133 .RS 4
134 .\}
135 .nf
136 4\-byte extension signature\&. If the first byte is \(aqA\(aq\&.\&.\(aqZ\(aq the
137 extension is optional and can be ignored\&.
138 .fi
139 .if n \{\
140 .RE
141 .\}
142 .sp
143 .if n \{\
144 .RS 4
145 .\}
146 .nf
147 32\-bit size of the extension
148 .fi
149 .if n \{\
150 .RE
151 .\}
152 .sp
153 .if n \{\
154 .RS 4
155 .\}
156 .nf
157 Extension data
158 .fi
159 .if n \{\
160 .RE
161 .\}
162 .RE
163 .sp
164 .RS 4
165 .ie n \{\
166 \h'-04'\(bu\h'+03'\c
167 .\}
168 .el \{\
169 .sp -1
170 .IP \(bu 2.3
171 .\}
172 Hash checksum over the content of the index file before this checksum\&.
173 .RE
174 .SH "INDEX ENTRY"
175 .sp
176 .if n \{\
177 .RS 4
178 .\}
179 .nf
180 Index entries are sorted in ascending order on the name field,
181 interpreted as a string of unsigned bytes (i\&.e\&. memcmp() order, no
182 localization, no special casing of directory separator \(aq/\(aq)\&. Entries
183 with the same name are sorted by their stage field\&.
184 .fi
185 .if n \{\
186 .RE
187 .\}
188 .sp
189 .if n \{\
190 .RS 4
191 .\}
192 .nf
193 An index entry typically represents a file\&. However, if sparse\-checkout
194 is enabled in cone mode (`core\&.sparseCheckoutCone` is enabled) and the
195 `extensions\&.sparseIndex` extension is enabled, then the index may
196 contain entries for directories outside of the sparse\-checkout definition\&.
197 These entries have mode `040000`, include the `SKIP_WORKTREE` bit, and
198 the path ends in a directory separator\&.
199 .fi
200 .if n \{\
201 .RE
202 .\}
203 .sp
204 .if n \{\
205 .RS 4
206 .\}
207 .nf
208 32\-bit ctime seconds, the last time a file\(aqs metadata changed
209 this is stat(2) data
210 .fi
211 .if n \{\
212 .RE
213 .\}
214 .sp
215 .if n \{\
216 .RS 4
217 .\}
218 .nf
219 32\-bit ctime nanosecond fractions
220 this is stat(2) data
221 .fi
222 .if n \{\
223 .RE
224 .\}
225 .sp
226 .if n \{\
227 .RS 4
228 .\}
229 .nf
230 32\-bit mtime seconds, the last time a file\(aqs data changed
231 this is stat(2) data
232 .fi
233 .if n \{\
234 .RE
235 .\}
236 .sp
237 .if n \{\
238 .RS 4
239 .\}
240 .nf
241 32\-bit mtime nanosecond fractions
242 this is stat(2) data
243 .fi
244 .if n \{\
245 .RE
246 .\}
247 .sp
248 .if n \{\
249 .RS 4
250 .\}
251 .nf
252 32\-bit dev
253 this is stat(2) data
254 .fi
255 .if n \{\
256 .RE
257 .\}
258 .sp
259 .if n \{\
260 .RS 4
261 .\}
262 .nf
263 32\-bit ino
264 this is stat(2) data
265 .fi
266 .if n \{\
267 .RE
268 .\}
269 .sp
270 .if n \{\
271 .RS 4
272 .\}
273 .nf
274 32\-bit mode, split into (high to low bits)
275 .fi
276 .if n \{\
277 .RE
278 .\}
279 .sp
280 .if n \{\
281 .RS 4
282 .\}
283 .nf
284 4\-bit object type
285 valid values in binary are 1000 (regular file), 1010 (symbolic link)
286 and 1110 (gitlink)
287 .fi
288 .if n \{\
289 .RE
290 .\}
291 .sp
292 .if n \{\
293 .RS 4
294 .\}
295 .nf
296 3\-bit unused
297 .fi
298 .if n \{\
299 .RE
300 .\}
301 .sp
302 .if n \{\
303 .RS 4
304 .\}
305 .nf
306 9\-bit unix permission\&. Only 0755 and 0644 are valid for regular files\&.
307 Symbolic links and gitlinks have value 0 in this field\&.
308 .fi
309 .if n \{\
310 .RE
311 .\}
312 .sp
313 .if n \{\
314 .RS 4
315 .\}
316 .nf
317 32\-bit uid
318 this is stat(2) data
319 .fi
320 .if n \{\
321 .RE
322 .\}
323 .sp
324 .if n \{\
325 .RS 4
326 .\}
327 .nf
328 32\-bit gid
329 this is stat(2) data
330 .fi
331 .if n \{\
332 .RE
333 .\}
334 .sp
335 .if n \{\
336 .RS 4
337 .\}
338 .nf
339 32\-bit file size
340 This is the on\-disk size from stat(2), truncated to 32\-bit\&.
341 .fi
342 .if n \{\
343 .RE
344 .\}
345 .sp
346 .if n \{\
347 .RS 4
348 .\}
349 .nf
350 Object name for the represented object
351 .fi
352 .if n \{\
353 .RE
354 .\}
355 .sp
356 .if n \{\
357 .RS 4
358 .\}
359 .nf
360 A 16\-bit \(aqflags\(aq field split into (high to low bits)
361 .fi
362 .if n \{\
363 .RE
364 .\}
365 .sp
366 .if n \{\
367 .RS 4
368 .\}
369 .nf
370 1\-bit assume\-valid flag
371 .fi
372 .if n \{\
373 .RE
374 .\}
375 .sp
376 .if n \{\
377 .RS 4
378 .\}
379 .nf
380 1\-bit extended flag (must be zero in version 2)
381 .fi
382 .if n \{\
383 .RE
384 .\}
385 .sp
386 .if n \{\
387 .RS 4
388 .\}
389 .nf
390 2\-bit stage (during merge)
391 .fi
392 .if n \{\
393 .RE
394 .\}
395 .sp
396 .if n \{\
397 .RS 4
398 .\}
399 .nf
400 12\-bit name length if the length is less than 0xFFF; otherwise 0xFFF
401 is stored in this field\&.
402 .fi
403 .if n \{\
404 .RE
405 .\}
406 .sp
407 .if n \{\
408 .RS 4
409 .\}
410 .nf
411 (Version 3 or later) A 16\-bit field, only applicable if the
412 "extended flag" above is 1, split into (high to low bits)\&.
413 .fi
414 .if n \{\
415 .RE
416 .\}
417 .sp
418 .if n \{\
419 .RS 4
420 .\}
421 .nf
422 1\-bit reserved for future
423 .fi
424 .if n \{\
425 .RE
426 .\}
427 .sp
428 .if n \{\
429 .RS 4
430 .\}
431 .nf
432 1\-bit skip\-worktree flag (used by sparse checkout)
433 .fi
434 .if n \{\
435 .RE
436 .\}
437 .sp
438 .if n \{\
439 .RS 4
440 .\}
441 .nf
442 1\-bit intent\-to\-add flag (used by "git add \-N")
443 .fi
444 .if n \{\
445 .RE
446 .\}
447 .sp
448 .if n \{\
449 .RS 4
450 .\}
451 .nf
452 13\-bit unused, must be zero
453 .fi
454 .if n \{\
455 .RE
456 .\}
457 .sp
458 .if n \{\
459 .RS 4
460 .\}
461 .nf
462 Entry path name (variable length) relative to top level directory
463 (without leading slash)\&. \(aq/\(aq is used as path separator\&. The special
464 path components "\&.", "\&.\&." and "\&.git" (without quotes) are disallowed\&.
465 Trailing slash is also disallowed\&.
466 .fi
467 .if n \{\
468 .RE
469 .\}
470 .sp
471 .if n \{\
472 .RS 4
473 .\}
474 .nf
475 The exact encoding is undefined, but the \(aq\&.\(aq and \(aq/\(aq characters
476 are encoded in 7\-bit ASCII and the encoding cannot contain a NUL
477 byte (iow, this is a UNIX pathname)\&.
478 .fi
479 .if n \{\
480 .RE
481 .\}
482 .sp
483 .if n \{\
484 .RS 4
485 .\}
486 .nf
487 (Version 4) In version 4, the entry path name is prefix\-compressed
488 relative to the path name for the previous entry (the very first
489 entry is encoded as if the path name for the previous entry is an
490 empty string)\&. At the beginning of an entry, an integer N in the
491 variable width encoding (the same encoding as the offset is encoded
492 for OFS_DELTA pack entries; see linkgit:gitformat\-pack[5]) is stored, followed
493 by a NUL\-terminated string S\&. Removing N bytes from the end of the
494 path name for the previous entry, and replacing it with the string S
495 yields the path name for this entry\&.
496 .fi
497 .if n \{\
498 .RE
499 .\}
500 .sp
501 .if n \{\
502 .RS 4
503 .\}
504 .nf
505 1\-8 nul bytes as necessary to pad the entry to a multiple of eight bytes
506 while keeping the name NUL\-terminated\&.
507 .fi
508 .if n \{\
509 .RE
510 .\}
511 .sp
512 .if n \{\
513 .RS 4
514 .\}
515 .nf
516 (Version 4) In version 4, the padding after the pathname does not
517 exist\&.
518 .fi
519 .if n \{\
520 .RE
521 .\}
522 .sp
523 .if n \{\
524 .RS 4
525 .\}
526 .nf
527 Interpretation of index entries in split index mode is completely
528 different\&. See below for details\&.
529 .fi
530 .if n \{\
531 .RE
532 .\}
533 .SH "EXTENSIONS"
534 .SS "Cache tree"
535 .sp
536 .if n \{\
537 .RS 4
538 .\}
539 .nf
540 Since the index does not record entries for directories, the cache
541 entries cannot describe tree objects that already exist in the object
542 database for regions of the index that are unchanged from an existing
543 commit\&. The cache tree extension stores a recursive tree structure that
544 describes the trees that already exist and completely match sections of
545 the cache entries\&. This speeds up tree object generation from the index
546 for a new commit by only computing the trees that are "new" to that
547 commit\&. It also assists when comparing the index to another tree, such
548 as `HEAD^{tree}`, since sections of the index can be skipped when a tree
549 comparison demonstrates equality\&.
550 .fi
551 .if n \{\
552 .RE
553 .\}
554 .sp
555 .if n \{\
556 .RS 4
557 .\}
558 .nf
559 The recursive tree structure uses nodes that store a number of cache
560 entries, a list of subnodes, and an object ID (OID)\&. The OID references
561 the existing tree for that node, if it is known to exist\&. The subnodes
562 correspond to subdirectories that themselves have cache tree nodes\&. The
563 number of cache entries corresponds to the number of cache entries in
564 the index that describe paths within that tree\(aqs directory\&.
565 .fi
566 .if n \{\
567 .RE
568 .\}
569 .sp
570 .if n \{\
571 .RS 4
572 .\}
573 .nf
574 The extension tracks the full directory structure in the cache tree
575 extension, but this is generally smaller than the full cache entry list\&.
576 .fi
577 .if n \{\
578 .RE
579 .\}
580 .sp
581 .if n \{\
582 .RS 4
583 .\}
584 .nf
585 When a path is updated in index, Git invalidates all nodes of the
586 recursive cache tree corresponding to the parent directories of that
587 path\&. We store these tree nodes as being "invalid" by using "\-1" as the
588 number of cache entries\&. Invalid nodes still store a span of index
589 entries, allowing Git to focus its efforts when reconstructing a full
590 cache tree\&.
591 .fi
592 .if n \{\
593 .RE
594 .\}
595 .sp
596 .if n \{\
597 .RS 4
598 .\}
599 .nf
600 The signature for this extension is { \(aqT\(aq, \(aqR\(aq, \(aqE\(aq, \(aqE\(aq }\&.
601 .fi
602 .if n \{\
603 .RE
604 .\}
605 .sp
606 .if n \{\
607 .RS 4
608 .\}
609 .nf
610 A series of entries fill the entire extension; each of which
611 consists of:
612 .fi
613 .if n \{\
614 .RE
615 .\}
616 .sp
617 .RS 4
618 .ie n \{\
619 \h'-04'\(bu\h'+03'\c
620 .\}
621 .el \{\
622 .sp -1
623 .IP \(bu 2.3
624 .\}
625 NUL\-terminated path component (relative to its parent directory);
626 .RE
627 .sp
628 .RS 4
629 .ie n \{\
630 \h'-04'\(bu\h'+03'\c
631 .\}
632 .el \{\
633 .sp -1
634 .IP \(bu 2.3
635 .\}
636 ASCII decimal number of entries in the index that is covered by the tree this entry represents (entry_count);
637 .RE
638 .sp
639 .RS 4
640 .ie n \{\
641 \h'-04'\(bu\h'+03'\c
642 .\}
643 .el \{\
644 .sp -1
645 .IP \(bu 2.3
646 .\}
647 A space (ASCII 32);
648 .RE
649 .sp
650 .RS 4
651 .ie n \{\
652 \h'-04'\(bu\h'+03'\c
653 .\}
654 .el \{\
655 .sp -1
656 .IP \(bu 2.3
657 .\}
658 ASCII decimal number that represents the number of subtrees this tree has;
659 .RE
660 .sp
661 .RS 4
662 .ie n \{\
663 \h'-04'\(bu\h'+03'\c
664 .\}
665 .el \{\
666 .sp -1
667 .IP \(bu 2.3
668 .\}
669 A newline (ASCII 10); and
670 .RE
671 .sp
672 .RS 4
673 .ie n \{\
674 \h'-04'\(bu\h'+03'\c
675 .\}
676 .el \{\
677 .sp -1
678 .IP \(bu 2.3
679 .\}
680 Object name for the object that would result from writing this span of index as a tree\&.
681 .sp
682 .if n \{\
683 .RS 4
684 .\}
685 .nf
686 An entry can be in an invalidated state and is represented by having
687 a negative number in the entry_count field\&. In this case, there is no
688 object name and the next entry starts immediately after the newline\&.
689 When writing an invalid entry, \-1 should always be used as entry_count\&.
690 .fi
691 .if n \{\
692 .RE
693 .\}
694 .sp
695 .if n \{\
696 .RS 4
697 .\}
698 .nf
699 The entries are written out in the top\-down, depth\-first order\&. The
700 first entry represents the root level of the repository, followed by the
701 first subtree\-\-let\(aqs call this A\-\-of the root level (with its name
702 relative to the root level), followed by the first subtree of A (with
703 its name relative to A), and so on\&. The specified number of subtrees
704 indicates when the current level of the recursive stack is complete\&.
705 .fi
706 .if n \{\
707 .RE
708 .\}
709 .RE
710 .SS "Resolve undo"
711 .sp
712 .if n \{\
713 .RS 4
714 .\}
715 .nf
716 A conflict is represented in the index as a set of higher stage entries\&.
717 When a conflict is resolved (e\&.g\&. with "git add path"), these higher
718 stage entries will be removed and a stage\-0 entry with proper resolution
719 is added\&.
720 .fi
721 .if n \{\
722 .RE
723 .\}
724 .sp
725 .if n \{\
726 .RS 4
727 .\}
728 .nf
729 When these higher stage entries are removed, they are saved in the
730 resolve undo extension, so that conflicts can be recreated (e\&.g\&. with
731 "git checkout \-m"), in case users want to redo a conflict resolution
732 from scratch\&.
733 .fi
734 .if n \{\
735 .RE
736 .\}
737 .sp
738 .if n \{\
739 .RS 4
740 .\}
741 .nf
742 The signature for this extension is { \(aqR\(aq, \(aqE\(aq, \(aqU\(aq, \(aqC\(aq }\&.
743 .fi
744 .if n \{\
745 .RE
746 .\}
747 .sp
748 .if n \{\
749 .RS 4
750 .\}
751 .nf
752 A series of entries fill the entire extension; each of which
753 consists of:
754 .fi
755 .if n \{\
756 .RE
757 .\}
758 .sp
759 .RS 4
760 .ie n \{\
761 \h'-04'\(bu\h'+03'\c
762 .\}
763 .el \{\
764 .sp -1
765 .IP \(bu 2.3
766 .\}
767 NUL\-terminated pathname the entry describes (relative to the root of the repository, i\&.e\&. full pathname);
768 .RE
769 .sp
770 .RS 4
771 .ie n \{\
772 \h'-04'\(bu\h'+03'\c
773 .\}
774 .el \{\
775 .sp -1
776 .IP \(bu 2.3
777 .\}
778 Three NUL\-terminated ASCII octal numbers, entry mode of entries in stage 1 to 3 (a missing stage is represented by "0" in this field); and
779 .RE
780 .sp
781 .RS 4
782 .ie n \{\
783 \h'-04'\(bu\h'+03'\c
784 .\}
785 .el \{\
786 .sp -1
787 .IP \(bu 2.3
788 .\}
789 At most three object names of the entry in stages from 1 to 3 (nothing is written for a missing stage)\&.
790 .RE
791 .SS "Split index"
792 .sp
793 .if n \{\
794 .RS 4
795 .\}
796 .nf
797 In split index mode, the majority of index entries could be stored
798 in a separate file\&. This extension records the changes to be made on
799 top of that to produce the final index\&.
800 .fi
801 .if n \{\
802 .RE
803 .\}
804 .sp
805 .if n \{\
806 .RS 4
807 .\}
808 .nf
809 The signature for this extension is { \(aql\(aq, \(aqi\(aq, \(aqn\(aq, \(aqk\(aq }\&.
810 .fi
811 .if n \{\
812 .RE
813 .\}
814 .sp
815 .if n \{\
816 .RS 4
817 .\}
818 .nf
819 The extension consists of:
820 .fi
821 .if n \{\
822 .RE
823 .\}
824 .sp
825 .RS 4
826 .ie n \{\
827 \h'-04'\(bu\h'+03'\c
828 .\}
829 .el \{\
830 .sp -1
831 .IP \(bu 2.3
832 .\}
833 Hash of the shared index file\&. The shared index file path is $GIT_DIR/sharedindex\&.<hash>\&. If all bits are zero, the index does not require a shared index file\&.
834 .RE
835 .sp
836 .RS 4
837 .ie n \{\
838 \h'-04'\(bu\h'+03'\c
839 .\}
840 .el \{\
841 .sp -1
842 .IP \(bu 2.3
843 .\}
844 An ewah\-encoded delete bitmap, each bit represents an entry in the shared index\&. If a bit is set, its corresponding entry in the shared index will be removed from the final index\&. Note, because a delete operation changes index entry positions, but we do need original positions in replace phase, it\(cqs best to just mark entries for removal, then do a mass deletion after replacement\&.
845 .RE
846 .sp
847 .RS 4
848 .ie n \{\
849 \h'-04'\(bu\h'+03'\c
850 .\}
851 .el \{\
852 .sp -1
853 .IP \(bu 2.3
854 .\}
855 An ewah\-encoded replace bitmap, each bit represents an entry in the shared index\&. If a bit is set, its corresponding entry in the shared index will be replaced with an entry in this index file\&. All replaced entries are stored in sorted order in this index\&. The first "1" bit in the replace bitmap corresponds to the first index entry, the second "1" bit to the second entry and so on\&. Replaced entries may have empty path names to save space\&.
856 .sp
857 .if n \{\
858 .RS 4
859 .\}
860 .nf
861 The remaining index entries after replaced ones will be added to the
862 final index\&. These added entries are also sorted by entry name then
863 stage\&.
864 .fi
865 .if n \{\
866 .RE
867 .\}
868 .RE
869 .SH "UNTRACKED CACHE"
870 .sp
871 .if n \{\
872 .RS 4
873 .\}
874 .nf
875 Untracked cache saves the untracked file list and necessary data to
876 verify the cache\&. The signature for this extension is { \(aqU\(aq, \(aqN\(aq,
877 \(aqT\(aq, \(aqR\(aq }\&.
878 .fi
879 .if n \{\
880 .RE
881 .\}
882 .sp
883 .if n \{\
884 .RS 4
885 .\}
886 .nf
887 The extension starts with
888 .fi
889 .if n \{\
890 .RE
891 .\}
892 .sp
893 .RS 4
894 .ie n \{\
895 \h'-04'\(bu\h'+03'\c
896 .\}
897 .el \{\
898 .sp -1
899 .IP \(bu 2.3
900 .\}
901 A sequence of NUL\-terminated strings, preceded by the size of the sequence in variable width encoding\&. Each string describes the environment where the cache can be used\&.
902 .RE
903 .sp
904 .RS 4
905 .ie n \{\
906 \h'-04'\(bu\h'+03'\c
907 .\}
908 .el \{\
909 .sp -1
910 .IP \(bu 2.3
911 .\}
912 Stat data of $GIT_DIR/info/exclude\&. See "Index entry" section from ctime field until "file size"\&.
913 .RE
914 .sp
915 .RS 4
916 .ie n \{\
917 \h'-04'\(bu\h'+03'\c
918 .\}
919 .el \{\
920 .sp -1
921 .IP \(bu 2.3
922 .\}
923 Stat data of core\&.excludesFile
924 .RE
925 .sp
926 .RS 4
927 .ie n \{\
928 \h'-04'\(bu\h'+03'\c
929 .\}
930 .el \{\
931 .sp -1
932 .IP \(bu 2.3
933 .\}
934 32\-bit dir_flags (see struct dir_struct)
935 .RE
936 .sp
937 .RS 4
938 .ie n \{\
939 \h'-04'\(bu\h'+03'\c
940 .\}
941 .el \{\
942 .sp -1
943 .IP \(bu 2.3
944 .\}
945 Hash of $GIT_DIR/info/exclude\&. A null hash means the file does not exist\&.
946 .RE
947 .sp
948 .RS 4
949 .ie n \{\
950 \h'-04'\(bu\h'+03'\c
951 .\}
952 .el \{\
953 .sp -1
954 .IP \(bu 2.3
955 .\}
956 Hash of core\&.excludesFile\&. A null hash means the file does not exist\&.
957 .RE
958 .sp
959 .RS 4
960 .ie n \{\
961 \h'-04'\(bu\h'+03'\c
962 .\}
963 .el \{\
964 .sp -1
965 .IP \(bu 2.3
966 .\}
967 NUL\-terminated string of per\-dir exclude file name\&. This usually is "\&.gitignore"\&.
968 .RE
969 .sp
970 .RS 4
971 .ie n \{\
972 \h'-04'\(bu\h'+03'\c
973 .\}
974 .el \{\
975 .sp -1
976 .IP \(bu 2.3
977 .\}
978 The number of following directory blocks, variable width encoding\&. If this number is zero, the extension ends here with a following NUL\&.
979 .RE
980 .sp
981 .RS 4
982 .ie n \{\
983 \h'-04'\(bu\h'+03'\c
984 .\}
985 .el \{\
986 .sp -1
987 .IP \(bu 2.3
988 .\}
989 A number of directory blocks in depth\-first\-search order, each consists of
990 .RE
991 .sp
992 .RS 4
993 .ie n \{\
994 \h'-04'\(bu\h'+03'\c
995 .\}
996 .el \{\
997 .sp -1
998 .IP \(bu 2.3
999 .\}
1000 The number of untracked entries, variable width encoding\&.
1001 .RE
1002 .sp
1003 .RS 4
1004 .ie n \{\
1005 \h'-04'\(bu\h'+03'\c
1006 .\}
1007 .el \{\
1008 .sp -1
1009 .IP \(bu 2.3
1010 .\}
1011 The number of sub\-directory blocks, variable width encoding\&.
1012 .RE
1013 .sp
1014 .RS 4
1015 .ie n \{\
1016 \h'-04'\(bu\h'+03'\c
1017 .\}
1018 .el \{\
1019 .sp -1
1020 .IP \(bu 2.3
1021 .\}
1022 The directory name terminated by NUL\&.
1023 .RE
1024 .sp
1025 .RS 4
1026 .ie n \{\
1027 \h'-04'\(bu\h'+03'\c
1028 .\}
1029 .el \{\
1030 .sp -1
1031 .IP \(bu 2.3
1032 .\}
1033 A number of untracked file/dir names terminated by NUL\&.
1034 .RE
1035 .sp
1036 The remaining data of each directory block is grouped by type:
1037 .sp
1038 .RS 4
1039 .ie n \{\
1040 \h'-04'\(bu\h'+03'\c
1041 .\}
1042 .el \{\
1043 .sp -1
1044 .IP \(bu 2.3
1045 .\}
1046 An ewah bitmap, the n\-th bit marks whether the n\-th directory has valid untracked cache entries\&.
1047 .RE
1048 .sp
1049 .RS 4
1050 .ie n \{\
1051 \h'-04'\(bu\h'+03'\c
1052 .\}
1053 .el \{\
1054 .sp -1
1055 .IP \(bu 2.3
1056 .\}
1057 An ewah bitmap, the n\-th bit records "check\-only" bit of read_directory_recursive() for the n\-th directory\&.
1058 .RE
1059 .sp
1060 .RS 4
1061 .ie n \{\
1062 \h'-04'\(bu\h'+03'\c
1063 .\}
1064 .el \{\
1065 .sp -1
1066 .IP \(bu 2.3
1067 .\}
1068 An ewah bitmap, the n\-th bit indicates whether hash and stat data is valid for the n\-th directory and exists in the next data\&.
1069 .RE
1070 .sp
1071 .RS 4
1072 .ie n \{\
1073 \h'-04'\(bu\h'+03'\c
1074 .\}
1075 .el \{\
1076 .sp -1
1077 .IP \(bu 2.3
1078 .\}
1079 An array of stat data\&. The n\-th data corresponds with the n\-th "one" bit in the previous ewah bitmap\&.
1080 .RE
1081 .sp
1082 .RS 4
1083 .ie n \{\
1084 \h'-04'\(bu\h'+03'\c
1085 .\}
1086 .el \{\
1087 .sp -1
1088 .IP \(bu 2.3
1089 .\}
1090 An array of hashes\&. The n\-th hash corresponds with the n\-th "one" bit in the previous ewah bitmap\&.
1091 .RE
1092 .sp
1093 .RS 4
1094 .ie n \{\
1095 \h'-04'\(bu\h'+03'\c
1096 .\}
1097 .el \{\
1098 .sp -1
1099 .IP \(bu 2.3
1100 .\}
1101 One NUL\&.
1102 .RE
1103 .SH "FILE SYSTEM MONITOR CACHE"
1104 .sp
1105 .if n \{\
1106 .RS 4
1107 .\}
1108 .nf
1109 The file system monitor cache tracks files for which the core\&.fsmonitor
1110 hook has told us about changes\&. The signature for this extension is
1111 { \(aqF\(aq, \(aqS\(aq, \(aqM\(aq, \(aqN\(aq }\&.
1112 .fi
1113 .if n \{\
1114 .RE
1115 .\}
1116 .sp
1117 .if n \{\
1118 .RS 4
1119 .\}
1120 .nf
1121 The extension starts with
1122 .fi
1123 .if n \{\
1124 .RE
1125 .\}
1126 .sp
1127 .RS 4
1128 .ie n \{\
1129 \h'-04'\(bu\h'+03'\c
1130 .\}
1131 .el \{\
1132 .sp -1
1133 .IP \(bu 2.3
1134 .\}
1135 32\-bit version number: the current supported versions are 1 and 2\&.
1136 .RE
1137 .sp
1138 .RS 4
1139 .ie n \{\
1140 \h'-04'\(bu\h'+03'\c
1141 .\}
1142 .el \{\
1143 .sp -1
1144 .IP \(bu 2.3
1145 .\}
1146 (Version 1) 64\-bit time: the extension data reflects all changes through the given time which is stored as the nanoseconds elapsed since midnight, January 1, 1970\&.
1147 .RE
1148 .sp
1149 .RS 4
1150 .ie n \{\
1151 \h'-04'\(bu\h'+03'\c
1152 .\}
1153 .el \{\
1154 .sp -1
1155 .IP \(bu 2.3
1156 .\}
1157 (Version 2) A null terminated string: an opaque token defined by the file system monitor application\&. The extension data reflects all changes relative to that token\&.
1158 .RE
1159 .sp
1160 .RS 4
1161 .ie n \{\
1162 \h'-04'\(bu\h'+03'\c
1163 .\}
1164 .el \{\
1165 .sp -1
1166 .IP \(bu 2.3
1167 .\}
1168 32\-bit bitmap size: the size of the CE_FSMONITOR_VALID bitmap\&.
1169 .RE
1170 .sp
1171 .RS 4
1172 .ie n \{\
1173 \h'-04'\(bu\h'+03'\c
1174 .\}
1175 .el \{\
1176 .sp -1
1177 .IP \(bu 2.3
1178 .\}
1179 An ewah bitmap, the n\-th bit indicates whether the n\-th index entry is not CE_FSMONITOR_VALID\&.
1180 .RE
1181 .SH "END OF INDEX ENTRY"
1182 .sp
1183 .if n \{\
1184 .RS 4
1185 .\}
1186 .nf
1187 The End of Index Entry (EOIE) is used to locate the end of the variable
1188 length index entries and the beginning of the extensions\&. Code can take
1189 advantage of this to quickly locate the index extensions without having
1190 to parse through all of the index entries\&.
1191 .fi
1192 .if n \{\
1193 .RE
1194 .\}
1195 .sp
1196 .if n \{\
1197 .RS 4
1198 .\}
1199 .nf
1200 Because it must be able to be loaded before the variable length cache
1201 entries and other index extensions, this extension must be written last\&.
1202 The signature for this extension is { \(aqE\(aq, \(aqO\(aq, \(aqI\(aq, \(aqE\(aq }\&.
1203 .fi
1204 .if n \{\
1205 .RE
1206 .\}
1207 .sp
1208 .if n \{\
1209 .RS 4
1210 .\}
1211 .nf
1212 The extension consists of:
1213 .fi
1214 .if n \{\
1215 .RE
1216 .\}
1217 .sp
1218 .RS 4
1219 .ie n \{\
1220 \h'-04'\(bu\h'+03'\c
1221 .\}
1222 .el \{\
1223 .sp -1
1224 .IP \(bu 2.3
1225 .\}
1226 32\-bit offset to the end of the index entries
1227 .RE
1228 .sp
1229 .RS 4
1230 .ie n \{\
1231 \h'-04'\(bu\h'+03'\c
1232 .\}
1233 .el \{\
1234 .sp -1
1235 .IP \(bu 2.3
1236 .\}
1237 Hash over the extension types and their sizes (but not their contents)\&. E\&.g\&. if we have "TREE" extension that is N\-bytes long, "REUC" extension that is M\-bytes long, followed by "EOIE", then the hash would be:
1238 .sp
1239 .if n \{\
1240 .RS 4
1241 .\}
1242 .nf
1243 Hash("TREE" + <binary representation of N> +
1244 "REUC" + <binary representation of M>)
1245 .fi
1246 .if n \{\
1247 .RE
1248 .\}
1249 .RE
1250 .SH "INDEX ENTRY OFFSET TABLE"
1251 .sp
1252 .if n \{\
1253 .RS 4
1254 .\}
1255 .nf
1256 The Index Entry Offset Table (IEOT) is used to help address the CPU
1257 cost of loading the index by enabling multi\-threading the process of
1258 converting cache entries from the on\-disk format to the in\-memory format\&.
1259 The signature for this extension is { \(aqI\(aq, \(aqE\(aq, \(aqO\(aq, \(aqT\(aq }\&.
1260 .fi
1261 .if n \{\
1262 .RE
1263 .\}
1264 .sp
1265 .if n \{\
1266 .RS 4
1267 .\}
1268 .nf
1269 The extension consists of:
1270 .fi
1271 .if n \{\
1272 .RE
1273 .\}
1274 .sp
1275 .RS 4
1276 .ie n \{\
1277 \h'-04'\(bu\h'+03'\c
1278 .\}
1279 .el \{\
1280 .sp -1
1281 .IP \(bu 2.3
1282 .\}
1283 32\-bit version (currently 1)
1284 .RE
1285 .sp
1286 .RS 4
1287 .ie n \{\
1288 \h'-04'\(bu\h'+03'\c
1289 .\}
1290 .el \{\
1291 .sp -1
1292 .IP \(bu 2.3
1293 .\}
1294 A number of index offset entries each consisting of:
1295 .RE
1296 .sp
1297 .RS 4
1298 .ie n \{\
1299 \h'-04'\(bu\h'+03'\c
1300 .\}
1301 .el \{\
1302 .sp -1
1303 .IP \(bu 2.3
1304 .\}
1305 32\-bit offset from the beginning of the file to the first cache entry in this block of entries\&.
1306 .RE
1307 .sp
1308 .RS 4
1309 .ie n \{\
1310 \h'-04'\(bu\h'+03'\c
1311 .\}
1312 .el \{\
1313 .sp -1
1314 .IP \(bu 2.3
1315 .\}
1316 32\-bit count of cache entries in this block
1317 .RE
1318 .SH "SPARSE DIRECTORY ENTRIES"
1319 .sp
1320 .if n \{\
1321 .RS 4
1322 .\}
1323 .nf
1324 When using sparse\-checkout in cone mode, some entire directories within
1325 the index can be summarized by pointing to a tree object instead of the
1326 entire expanded list of paths within that tree\&. An index containing such
1327 entries is a "sparse index"\&. Index format versions 4 and less were not
1328 implemented with such entries in mind\&. Thus, for these versions, an
1329 index containing sparse directory entries will include this extension
1330 with signature { \(aqs\(aq, \(aqd\(aq, \(aqi\(aq, \(aqr\(aq }\&. Like the split\-index extension,
1331 tools should avoid interacting with a sparse index unless they understand
1332 this extension\&.
1333 .fi
1334 .if n \{\
1335 .RE
1336 .\}
1337 .SH "GIT"
1338 .sp
1339 Part of the \fBgit\fR(1) suite