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

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Feb 23, 2013, 20:53 UTC
Message-ID: <20130223205356.GC3222@elie.Belkin>
In-Reply-To: <1361584468-11820-1-git-send-email-pclouds@gmail.com>

Nguyễn Thái Ngọc Duy wrote:

Show 16 quoted lines

> --- 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 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