Skip to contentSkip to conversation

update-index doc: v4 is OK with JGit and libgit2

PATCH Superseded Junio C Hamano 2 participants 3 messages Aug 18, 2023 Documentation

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 update-index doc: v4 is OK with JGit and libgit2

Being invented in late 2012 no longer makes the index v4 format "relatively young".

The support for the index version 4 was added to libgit2 with their 5625d86b (index: support index v4, 2016-05-17) and to JGit with their e9cb0a8e (DirCache: support index V4, 2020-08-10).

Let's update the paragraph that discouraged its use for folks overly cautious about cross-tool compatibility.

---
 Documentation/git-update-index.txt | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
Documentation/git-update-index.txt +6 -3
index f4bb9c5daf..3d90d6f9ab 100644
@@ -166,9 +166,12 @@ you will need to handle the situation manually.
 +
 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. The first version to support it was Git 1.8.0 released in
+October 2012, and support for it was added to libgit2 in 2016 and
+JGit in 2020, respectively.  Older editions of this manual page called
+it "relatively young", but it should be considered mature technology
+these days.
+
 
 -z::
 	Only meaningful with `--stdin` or `--index-info`; paths are
Signature · 1 line
2.42.0-rc2-7-gf9972720e9
#1 lore raw

Review

Quoted 2 lines · Junio C Hamano
(quoted diff) +2 -0
+time. The first version to support it was Git 1.8.0 released in
+October 2012,

"Git supports it since version 1.8.0[, which was] released in October 2012, and ..." would be probably easier to read.

Quoted 1 line

and support for it was added to libgit2 in 2016 and

+to

Quoted 4 lines

+JGit in 2020,

respectively.

this use of "respectively" is bogus; just leave it off. it would make sense if you wrote "was added to libgit2 and jgit in 2016 and 2020, respectively", but this would just complicate matters.

regards

#2 lore raw
Quoted 9 lines · Oswald Buddenhagen

Review

Quoted 2 lines · Junio C Hamano
(quoted diff) +2 -0
+time. The first version to support it was Git 1.8.0 released in
+October 2012,

"Git supports it since version 1.8.0[, which was] released in October 2012, and ..." would be probably easier to read.

Quoted 1 line

and support for it was added to libgit2 in 2016 and

Quoted 7 lines

+to

Quoted 4 lines

+JGit in 2020,

respectively.

this use of "respectively" is bogus; just leave it off.

All good corrections. Thanks.