diff mbox series

[v2,1/3] update-index doc: v4 is OK with JGit and libgit2

Message ID 20230818233729.2766281-2-gitster@pobox.com (mailing list archive)
State Superseded
Headers show
Series "update-index --show-index-version" | expand

Commit Message

Junio C Hamano Aug. 18, 2023, 11:37 p.m. UTC
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.

Helped-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git-update-index.txt | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

Comments

Linus Arver Sept. 12, 2023, 4:57 a.m. UTC | #1
Junio C Hamano <gitster@pobox.com> writes:

> [...]
> diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
> index f4bb9c5daf..a367f8d65a 100644
> --- a/Documentation/git-update-index.txt
> +++ b/Documentation/git-update-index.txt
> @@ -166,9 +166,11 @@ 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.  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 editions of this manual page called it "relatively young", but

Nit: s/editions/versions because typically "edition" means a version of
physically published text (such as books). Also I don't think we use the
word "edition" anywhere else in our codebase.
Junio C Hamano Sept. 12, 2023, 5:14 p.m. UTC | #2
Linus Arver <linusa@google.com> writes:

> Junio C Hamano <gitster@pobox.com> writes:
> ...
>> +Older editions of this manual page called it "relatively young", but
>
> Nit: s/editions/versions because typically "edition" means a version of
> physically published text (such as books).

This text belonging to the manual, that was exactly the reason why I
used that word, but ...

> Also I don't think we use the
> word "edition" anywhere else in our codebase.

... I think "version" is just fine.  Will fix.

Thanks.
diff mbox series

Patch

diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index f4bb9c5daf..a367f8d65a 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -166,9 +166,11 @@  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.  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 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