summaryrefslogtreecommitdiff
path: root/Documentation/git-update-index.txt
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2013-03-25 13:45:26 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2013-03-25 13:45:26 -0700
commita7b6ad5e90be82f4089be39a78850d5f88e4d552 (patch)
tree978b2711a5d2b656a7abdd17288fa2f1c2d8a74d /Documentation/git-update-index.txt
parentMerge branch 'wk/doc-pre-rebase' into maint-1.8.1 (diff)
parentupdate-index: list supported idx versions and their features (diff)
downloadtgif-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/git-update-index.txt')
-rw-r--r--Documentation/git-update-index.txt10
1 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 9d0b1515c5..dd36d13285 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