Re: [PATCH] Documentation: Link git-ls-files to core.quotePath variable.

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 21, 2017, 20:48 UTC
Message-ID: <xmqqh93nfeyj.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <2b0ce702-60de-534b-8a86-5c7ae84060de@gmail.com>

Andreas Heiduk <asheiduk@gmail.com> writes:

Show 18 quoted lines

> Add a hint for script writers where additional quoting can be configured.
>
> Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
> ---
>  Documentation/git-ls-files.txt | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
> index 446209e..19e0636 100644
> --- a/Documentation/git-ls-files.txt
> +++ b/Documentation/git-ls-files.txt
> @@ -198,7 +198,8 @@ path. (see linkgit:git-read-tree[1] for more information on state)
>  
>  When `-z` option is not used, TAB, LF, and backslash characters
>  in pathnames are represented as `\t`, `\n`, and `\\`,
> -respectively.
> +respectively. The path is also quoted according to the
> +configuration variable `core.quotePath` (see linkgit:git-config[1]).

I was waiting for others to comment on this patch but nobody seems to be interested. Which is a bit sad, as this may not be a bad idea.

If we refer to core.quotePath, the mention of control characters being quoted can also be omitted, I think, as that is part of what appears in the description of core.quotePath variable.

Alternatively, instead of referring to another page, we can spend the additional lines to say what is more interesting to most of the readers from that page, e.g.

    When `-z` option is not used, a pathname with "unusual" characters
    in it is quoted by enclosing it in a double-quote pair and with
    backslashes the same way strings in C source code are quoted.  By
    setting core.quotePath configuration to false, the bytes whose
    values are higher than 0x80 are output verbatim.