diff options
| author | Junio C Hamano <gitster@pobox.com> | 2013-03-25 13:45:26 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-03-25 13:45:26 -0700 |
| commit | a7b6ad5e90be82f4089be39a78850d5f88e4d552 (patch) | |
| tree | 978b2711a5d2b656a7abdd17288fa2f1c2d8a74d /Documentation | |
| parent | 8ddd9c18f323234e73e5f4c5d2675e355c68db7e (diff) | |
| parent | 647d87947f8248df5608f621ece8b1dc875fa859 (diff) | |
| download | git-a7b6ad5e90be82f4089be39a78850d5f88e4d552.tar.gz git-a7b6ad5e90be82f4089be39a78850d5f88e4d552.tar.xz | |
Merge branch 'nd/doc-index-format' into maint-1.8.1
The v4 index format was not documented.
* nd/doc-index-format:
update-index: list supported idx versions and their features
read-cache.c: use INDEX_FORMAT_{LB,UB} in verify_hdr()
index-format.txt: mention of v4 is missing in some places
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-update-index.txt | 10 | ||||
| -rw-r--r-- | Documentation/technical/index-format.txt | 6 |
2 files changed, 12 insertions, 4 deletions
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 9d0b1515c..dd36d1328 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -145,7 +145,15 @@ you will need to handle the situation manually. --index-version <n>:: Write the resulting index out in the named on-disk format version. - The current default version is 2. + Supported versions are 2, 3 and 4. The current default version is 2 + or 3, depending on whether extra features are used, such as + `git add -N`. ++ +Version 4 performs a simple pathname compression that reduces index +size by 30%-50% on large repositories, which results in faster load +time. Version 4 is relatively young (first released in in 1.8.0 in +October 2012). Other Git implementations such as JGit and libgit2 +may not support it yet. -z:: Only meaningful with `--stdin` or `--index-info`; paths are diff --git a/Documentation/technical/index-format.txt b/Documentation/technical/index-format.txt index 732415483..dcd51b97d 100644 --- a/Documentation/technical/index-format.txt +++ b/Documentation/technical/index-format.txt @@ -12,7 +12,7 @@ GIT index format The signature is { 'D', 'I', 'R', 'C' } (stands for "dircache") 4-byte version number: - The current supported versions are 2 and 3. + The current supported versions are 2, 3 and 4. 32-bit number of index entries. @@ -93,8 +93,8 @@ GIT index format 12-bit name length if the length is less than 0xFFF; otherwise 0xFFF is stored in this field. - (Version 3) A 16-bit field, only applicable if the "extended flag" - above is 1, split into (high to low bits). + (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 |