English ▾ Themen ▾ Neueste Version ▾ gitformat-index zuletzt aktualisiert in 2.44.0

NAME

gitformat-index - Git-Indexformat

SYNOPSIS

$GIT_DIR/index

BESCHREIBUNG

Git-Indexformat

Die Git-Indexdatei hat das folgende Format

All binary numbers are in network byte order.
In a repository using the traditional SHA-1, checksums and object IDs
(object names) mentioned below are all computed using SHA-1.  Similarly,
in SHA-256 repositories, these values are computed using SHA-256.
Version 2 is described here unless stated otherwise.
  • Ein 12-Byte-Header bestehend aus

    4-byte signature:
      The signature is { 'D', 'I', 'R', 'C' } (stands for "dircache")
    4-byte version number:
      The current supported versions are 2, 3 and 4.
    32-bit number of index entries.
  • Eine Anzahl von sortierten Index-Einträgen (siehe unten).

  • Erweiterungen

    Extensions are identified by signature. Optional extensions can
    be ignored if Git does not understand them.
    4-byte extension signature. If the first byte is 'A'..'Z' the
    extension is optional and can be ignored.
    32-bit size of the extension
    Extension data
  • Hash-Prüfsumme über den Inhalt der Indexdatei vor dieser Prüfsumme.

Index-Eintrag

Index entries are sorted in ascending order on the name field,
interpreted as a string of unsigned bytes (i.e. memcmp() order, no
localization, no special casing of directory separator '/'). Entries
with the same name are sorted by their stage field.
An index entry typically represents a file. However, if sparse-checkout
is enabled in cone mode (`core.sparseCheckoutCone` is enabled) and the
`extensions.sparseIndex` extension is enabled, then the index may
contain entries for directories outside of the sparse-checkout definition.
These entries have mode `040000`, include the `SKIP_WORKTREE` bit, and
the path ends in a directory separator.
32-bit ctime seconds, the last time a file's metadata changed
  this is stat(2) data
32-bit ctime nanosecond fractions
  this is stat(2) data
32-bit mtime seconds, the last time a file's data changed
  this is stat(2) data
32-bit mtime nanosecond fractions
  this is stat(2) data
32-bit dev
  this is stat(2) data
32-bit ino
  this is stat(2) data
32-bit mode, split into (high to low bits)
16-bit unused, must be zero
4-bit object type
  valid values in binary are 1000 (regular file), 1010 (symbolic link)
  and 1110 (gitlink)
3-bit unused, must be zero
9-bit unix permission. Only 0755 and 0644 are valid for regular files.
Symbolic links and gitlinks have value 0 in this field.
32-bit uid
  this is stat(2) data
32-bit gid
  this is stat(2) data
32-bit file size
  This is the on-disk size from stat(2), truncated to 32-bit.
Object name for the represented object
A 16-bit 'flags' field split into (high to low bits)
1-bit assume-valid flag
1-bit extended flag (must be zero in version 2)
2-bit stage (during merge)
12-bit name length if the length is less than 0xFFF; otherwise 0xFFF
is stored in this field.
(Version 3 or later) A 16-bit field, only applicable if the
"extended flag" above is 1, split into (high to low bits).
1-bit reserved for future
1-bit skip-worktree flag (used by sparse checkout)
1-bit intent-to-add flag (used by "git add -N")
13-bit unused, must be zero
Entry path name (variable length) relative to top level directory
  (without leading slash). '/' is used as path separator. The special
  path components ".", ".." and ".git" (without quotes) are disallowed.
  Trailing slash is also disallowed.
The exact encoding is undefined, but the '.' and '/' characters
are encoded in 7-bit ASCII and the encoding cannot contain a NUL
byte (iow, this is a UNIX pathname).
(Version 4) In version 4, the entry path name is prefix-compressed
  relative to the path name for the previous entry (the very first
  entry is encoded as if the path name for the previous entry is an
  empty string).  At the beginning of an entry, an integer N in the
  variable width encoding (the same encoding as the offset is encoded
  for OFS_DELTA pack entries; see gitformat-pack[5]) is stored, followed
  by a NUL-terminated string S.  Removing N bytes from the end of the
  path name for the previous entry, and replacing it with the string S
  yields the path name for this entry.
1-8 nul bytes as necessary to pad the entry to a multiple of eight bytes
while keeping the name NUL-terminated.
(Version 4) In version 4, the padding after the pathname does not
exist.
Interpretation of index entries in split index mode is completely
different. See below for details.

Erweiterungen

Cache-Baum

Since the index does not record entries for directories, the cache
entries cannot describe tree objects that already exist in the object
database for regions of the index that are unchanged from an existing
commit. The cache tree extension stores a recursive tree structure that
describes the trees that already exist and completely match sections of
the cache entries. This speeds up tree object generation from the index
for a new commit by only computing the trees that are "new" to that
commit. It also assists when comparing the index to another tree, such
as `HEAD^{tree}`, since sections of the index can be skipped when a tree
comparison demonstrates equality.
The recursive tree structure uses nodes that store a number of cache
entries, a list of subnodes, and an object ID (OID). The OID references
the existing tree for that node, if it is known to exist. The subnodes
correspond to subdirectories that themselves have cache tree nodes. The
number of cache entries corresponds to the number of cache entries in
the index that describe paths within that tree's directory.
The extension tracks the full directory structure in the cache tree
extension, but this is generally smaller than the full cache entry list.
When a path is updated in index, Git invalidates all nodes of the
recursive cache tree corresponding to the parent directories of that
path. We store these tree nodes as being "invalid" by using "-1" as the
number of cache entries. Invalid nodes still store a span of index
entries, allowing Git to focus its efforts when reconstructing a full
cache tree.
The signature for this extension is { 'T', 'R', 'E', 'E' }.
A series of entries fill the entire extension; each of which
consists of:
  • NUL-terminierter Pfadkomponente (relativ zum Elternverzeichnis);

  • ASCII Dezimalzahl der Einträge im Index, die von dem Baum abgedeckt werden, den dieser Eintrag darstellt (entry_count);

  • Ein Leerzeichen (ASCII 32);

  • ASCII Dezimalzahl, die die Anzahl der Unterbäume darstellt, die dieser Baum hat;

  • Ein Zeilenumbruch (ASCII 10); und

  • Objektname für das Objekt, das sich aus dem Schreiben dieses Indexbereichs als Baum ergeben würde.

    An entry can be in an invalidated state and is represented by having
    a negative number in the entry_count field. In this case, there is no
    object name and the next entry starts immediately after the newline.
    When writing an invalid entry, -1 should always be used as entry_count.
    The entries are written out in the top-down, depth-first order.  The
    first entry represents the root level of the repository, followed by the
    first subtree--let's call this A--of the root level (with its name
    relative to the root level), followed by the first subtree of A (with
    its name relative to A), and so on. The specified number of subtrees
    indicates when the current level of the recursive stack is complete.

Auflösungsrückgängigmachung

A conflict is represented in the index as a set of higher stage entries.
When a conflict is resolved (e.g. with "git add path"), these higher
stage entries will be removed and a stage-0 entry with proper resolution
is added.
When these higher stage entries are removed, they are saved in the
resolve undo extension, so that conflicts can be recreated (e.g. with
"git checkout -m"), in case users want to redo a conflict resolution
from scratch.
The signature for this extension is { 'R', 'E', 'U', 'C' }.
A series of entries fill the entire extension; each of which
consists of:
  • NUL-terminierter Pfadname, den der Eintrag beschreibt (relativ zum Stamm des Repositorys, d.h. voller Pfadname);

  • Drei NUL-terminierte ASCII Oktalzahlen, die Eintragsmodi von Einträgen in den Stufen 1 bis 3 (eine fehlende Stufe wird in diesem Feld durch "0" dargestellt); und

  • Bis zu drei Objektnamen des Eintrags in den Stufen 1 bis 3 (für eine fehlende Stufe wird nichts geschrieben).

Split-Index

In split index mode, the majority of index entries could be stored
in a separate file. This extension records the changes to be made on
top of that to produce the final index.
The signature for this extension is { 'l', 'i', 'n', 'k' }.
The extension consists of:
  • Hash der gemeinsamen Indexdatei. Der Pfad der gemeinsamen Indexdatei ist $GIT_DIR/sharedindex.<hash>. Wenn alle Bits null sind, benötigt der Index keine gemeinsame Indexdatei.

  • Eine EWAH-kodierte Lösch-Bitmap, jedes Bit repräsentiert einen Eintrag im gemeinsamen Index. Wenn ein Bit gesetzt ist, wird sein entsprechender Eintrag im gemeinsamen Index aus dem endgültigen Index entfernt. Beachten Sie, dass da eine Löschoperation die Positionen der Indexeinträge ändert, wir aber die ursprünglichen Positionen in der Ersetzungsphase benötigen, ist es am besten, die Einträge nur zu markieren und nach der Ersetzung eine Massenlöschung durchzuführen.

  • Eine EWAH-kodierte Ersetzungs-Bitmap, jedes Bit repräsentiert einen Eintrag im gemeinsamen Index. Wenn ein Bit gesetzt ist, wird sein entsprechender Eintrag im gemeinsamen Index durch einen Eintrag in dieser Indexdatei ersetzt. Alle ersetzten Einträge werden in sortierter Reihenfolge in diesem Index gespeichert. Das erste "1"-Bit in der Ersetzungs-Bitmap entspricht dem ersten Indexeintrag, das zweite "1"-Bit dem zweiten Eintrag und so weiter. Ersetzte Einträge können leere Pfadnamen haben, um Platz zu sparen.

    The remaining index entries after replaced ones will be added to the
    final index. These added entries are also sorted by entry name then
    stage.

Nicht verfolgte Cache

Untracked cache saves the untracked file list and necessary data to
verify the cache. The signature for this extension is { 'U', 'N',
'T', 'R' }.
The extension starts with
  • Eine Folge von NUL-terminierten Zeichenketten, der die Größe der Folge in variabler Breitenkodierung vorangestellt ist. Jede Zeichenkette beschreibt die Umgebung, in der der Cache verwendet werden kann.

  • Statistiken von $GIT_DIR/info/exclude. Siehe "Index-Eintrag"-Abschnitt vom ctime-Feld bis zur "Dateigröße".

  • Statistiken von core.excludesFile

  • 32-Bit dir_flags (siehe struct dir_struct)

  • Hash von $GIT_DIR/info/exclude. Ein Null-Hash bedeutet, dass die Datei nicht existiert.

  • Hash von core.excludesFile. Ein Null-Hash bedeutet, dass die Datei nicht existiert.

  • NUL-terminierte Zeichenkette des ausgeschlossenen Dateinamens pro Verzeichnis. Dies ist normalerweise ".gitignore".

  • Die Anzahl der folgenden Verzeichnisblöcke, kodiert in variabler Breite. Wenn diese Zahl Null ist, endet die Erweiterung hier mit einem folgenden NUL.

  • Eine Anzahl von Verzeichnisblöcken in Tiefensuche-Reihenfolge, jede besteht aus

  • Die Anzahl der nicht verfolgten Einträge, kodiert in variabler Breite.

  • Die Anzahl der Unterverzeichnisblöcke, kodiert in variabler Breite.

  • Der Verzeichnisname, der mit NUL abgeschlossen ist.

  • Eine Anzahl von nicht verfolgten Datei-/Verzeichnisnamen, die mit NUL abgeschlossen sind.

Die verbleibenden Daten jedes Verzeichnisblocks sind nach Typ gruppiert

  • Eine EWAH-Bitmap, das n-te Bit markiert, ob das n-te Verzeichnis gültige nicht verfolgte Cache-Einträge hat.

  • Eine EWAH-Bitmap, das n-te Bit zeichnet das "nur prüfen"-Bit von read_directory_recursive() für das n-te Verzeichnis auf.

  • Eine EWAH-Bitmap, das n-te Bit zeigt an, ob Hash- und Stat-Daten für das n-te Verzeichnis gültig sind und im nächsten Datensatz vorhanden sind.

  • Ein Array von Stat-Daten. Die n-ten Daten entsprechen dem n-ten "eins"-Bit in der vorherigen EWAH-Bitmap.

  • Ein Array von Hashes. Der n-te Hash entspricht dem n-ten "eins"-Bit in der vorherigen EWAH-Bitmap.

  • Ein NUL.

Dateisystem-Monitor-Cache

The file system monitor cache tracks files for which the core.fsmonitor
hook has told us about changes.  The signature for this extension is
{ 'F', 'S', 'M', 'N' }.
The extension starts with
  • 32-Bit Versionsnummer: Die aktuell unterstützten Versionen sind 1 und 2.

  • (Version 1) 64-Bit-Zeit: Die Erweiterungsdaten spiegeln alle Änderungen bis zur angegebenen Zeit wider, die als Nanosekunden seit Mitternacht, 1. Januar 1970, gespeichert sind.

  • (Version 2) Eine NUL-terminierte Zeichenkette: Ein undurchsichtiger Token, der von der Dateisystem-Monitor-Anwendung definiert wird. Die Erweiterungsdaten spiegeln alle Änderungen relativ zu diesem Token wider.

  • 32-Bit Bitmap-Größe: Die Größe der CE_FSMONITOR_VALID-Bitmap.

  • Eine EWAH-Bitmap, das n-te Bit zeigt an, ob der n-te Indexeintrag nicht CE_FSMONITOR_VALID ist.

Ende des Index-Eintrags

The End of Index Entry (EOIE) is used to locate the end of the variable
length index entries and the beginning of the extensions. Code can take
advantage of this to quickly locate the index extensions without having
to parse through all of the index entries.
Because it must be able to be loaded before the variable length cache
entries and other index extensions, this extension must be written last.
The signature for this extension is { 'E', 'O', 'I', 'E' }.
The extension consists of:
  • 32-Bit-Offset zum Ende der Index-Einträge

  • Hash über die Erweiterungstypen und ihre Größen (aber nicht ihre Inhalte). Z.B. wenn wir eine "TREE"-Erweiterung haben, die N Bytes lang ist, eine "REUC"-Erweiterung, die M Bytes lang ist, gefolgt von "EOIE", dann wäre der Hash

    Hash("TREE" + <binary-representation-of-N> +
    	"REUC" + <binary-representation-of-M>)

Offset-Tabelle für Index-Einträge

The Index Entry Offset Table (IEOT) is used to help address the CPU
cost of loading the index by enabling multi-threading the process of
converting cache entries from the on-disk format to the in-memory format.
The signature for this extension is { 'I', 'E', 'O', 'T' }.
The extension consists of:
  • 32-Bit-Version (derzeit 1)

  • Eine Anzahl von Index-Offset-Einträgen, die jeweils aus

  • 32-Bit-Offset vom Beginn der Datei bis zum ersten Cache-Eintrag in diesem Block von Einträgen.

  • 32-Bit-Anzahl von Cache-Einträgen in diesem Block

Sparse Verzeichniseinträge

When using sparse-checkout in cone mode, some entire directories within
the index can be summarized by pointing to a tree object instead of the
entire expanded list of paths within that tree. An index containing such
entries is a "sparse index". Index format versions 4 and less were not
implemented with such entries in mind. Thus, for these versions, an
index containing sparse directory entries will include this extension
with signature { 's', 'd', 'i', 'r' }. Like the split-index extension,
tools should avoid interacting with a sparse index unless they understand
this extension.

GIT

Teil der git[1] Suite