aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2023-09-20 10:45:12 -0700
committerJunio C Hamano <gitster@pobox.com>2023-09-20 10:45:16 -0700
commit3c2af826a35ecba8533748db5bd0a4dbda2d33db (patch)
tree22eb0337f8113684e786a42a395c574ffb286355 /Documentation
parent767e4d68c7dab58e55c4f43ee8a490c946e480b8 (diff)
parent83708f80fc5fc7202df0bf3c0951f85d31249fe3 (diff)
downloadgit-3c2af826a35ecba8533748db5bd0a4dbda2d33db.tar.xz
Merge branch 'jc/update-index-show-index-version'
"git update-index" learns "--show-index-version" to inspect the index format version used by the on-disk index file. * jc/update-index-show-index-version: test-tool: retire "index-version" update-index: add --show-index-version update-index doc: v4 is OK with JGit and libgit2
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-update-index.txt14
1 files changed, 10 insertions, 4 deletions
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index f4bb9c5daf..1271486ae9 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -162,13 +162,19 @@ you will need to handle the situation manually.
Write the resulting index out in the named on-disk format version.
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`.
+ `git add -N`. With `--verbose`, also report the version the index
+ file uses before and after this command.
+
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 1.8.0 in
-October 2012). Other Git implementations such as JGit and libgit2
-may not support it yet.
+time. Git supports it since version 1.8.0, released in October 2012,
+and support for it was added to libgit2 in 2016 and to JGit in 2020.
+Older versions of this manual page called it "relatively young", but
+it should be considered mature technology these days.
+
+--show-index-version::
+ Report the index format version used by the on-disk index file.
+ See `--index-version` above.
-z::
Only meaningful with `--stdin` or `--index-info`; paths are