[PATCH 3/2] update-index: list supported idx versions and their features

2013-02-22 Thread Nguyễn Thái Ngọc Duy

Signed-off-by: Nguyễn Thái Ngọc Duy 
---
 .. and the user should know (briefly) the differences between index
 versions too.

 Documentation/git-update-index.txt | 10 +-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-update-index.txt 
b/Documentation/git-update-index.txt
index 77a912d..e5aaba5 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 ::
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 could
+   reduce 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 may not support it yet.
 
 -z::
Only meaningful with `--stdin` or `--index-info`; paths are
-- 
1.8.1.2.536.gf441e6d

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH 3/2] update-index: list supported idx versions and their features

2013-02-23 Thread Jonathan Nieder
Nguyễn Thái Ngọc Duy wrote:

> --- 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 ::
>   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 could
> + reduce 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 may not support it yet.

Markup nit: the second paragraph needs to be unindented, or asciidoc
will treat it as literal text, including line breaks.

Usage nit: s/could/can/

Clarity nit: something like "such as JGit and libgit2" after "Other
Git implementations" would make it clearer, at least to my eyes.

Aside from that, this looks like a good change.

Thanks,
Jonathan
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH 3/2] update-index: list supported idx versions and their features

2013-02-23 Thread Junio C Hamano
Thanks, both.

Jonathan Nieder  writes:

> Nguyễn Thái Ngọc Duy wrote:
> ...
>> +Version 4 performs a simple pathname compression that could
>> +reduce 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 may not support it yet.
>
> Usage nit: s/could/can/

I think s/could reduce/reduces/ is even simpler.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH 3/2] update-index: list supported idx versions and their features

2013-02-23 Thread Jonathan Nieder
Junio C Hamano wrote:
> Jonathan Nieder  writes:
>> Nguyễn Thái Ngọc Duy wrote:

>>> +   Version 4 performs a simple pathname compression that could
>>> +   reduce 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 may not support it yet.
>>
>> Usage nit: s/could/can/
>
> I think s/could reduce/reduces/ is even simpler.

Yes, true.  Thanks.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html