diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2013-03-19 12:15:14 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-03-19 12:15:14 -0700 |
| commit | 865e99b5fde9a9128b34b6f3805f726c7a3b1b13 (patch) | |
| tree | f35be308ff031c12ae41387a4bd6e6773678a96d /Documentation/git-update-index.txt | |
| parent | Merge branch 'wk/doc-pre-rebase' (diff) | |
| parent | update-index: list supported idx versions and their features (diff) | |
| download | tgif-865e99b5fde9a9128b34b6f3805f726c7a3b1b13.tar.xz | |
Merge branch 'nd/doc-index-format'
Update the index format documentation to mention the v4 format.
* 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/git-update-index.txt')
| -rw-r--r-- | Documentation/git-update-index.txt | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 77a912d4ea..c92775829b 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 |