Re: [PATCH] git-cat-file.txt: Document --textconv

From: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Date: Jun 24, 2010, 11:53 UTC
Message-ID: <vpqmxukir3e.fsf@bauges.imag.fr>
In-Reply-To: <2251bbc1e40505dcb80103bf5daebea07dc0e9f7.1277374210.git.git@drmicha.warpmail.net>

Michael J Gruber <git@drmicha.warpmail.net> writes:

> Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
> ---
> This formulation is based on my understanding that you can't cat-file
>  --textconv something in the index or worktree.

Actually, you can't textconv from the worktree, but you can from the index, saying

git cat-file --textconv :path/to/file

(the :<path> syntax is not specific here, you can use it in other Git commands)

> +--textconv::
> +	Show the content as transformed by a textconv filter. In this case,
> +	<object> has be of the form <treeish:path>, with treeish defaulting to
> +	HEAD.

So the "defaulting to HEAD" is incorrect. Also, I prefer <treeish>:<path> to <treeish:path>, to make it clear the : is actually a :.

What about this:

--textconv:: 
	Show the content as transformed by a textconv filter. In this
	case, <object> has be of the form <treeish>:<path>, or :<path>
	to run the filter on the file <path> stored in the index.

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/