Re: [PATCH v2 2/2] Documentation: Link descriptions of -z to core.quotePath

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 28, 2017, 21:25 UTC
Message-ID: <xmqq60juj9dw.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <d59bda7b-2eb5-a6cc-8240-0ff4f50de540@gmail.com>

Andreas Heiduk <asheiduk@gmail.com> writes:

> I'll fix the "munged" and, unless there are objections, I will also
> replace the remaining ones in the vicinity. These are the last
> occurrences of "munged".

I'd rather see the "we do not munge" to stay the same. "we do not quote" still allows us to do modifications that are different from quoting.

> You are OK with the references to another man page? My idea was to
> establish a well-known term.

The "well-known term" cannot just be "quote", because it is too generic. "git rev-parse --sq-quote" does a different kind of quoting from the quoting done here for paths with unusual characters, for example.

We certainly *could* (1) add to glossary-content.txt the definition of "c-quote" and describe it there, (2) change the "see the quoting explained for core.quotePath" to "unless -z is given, paths are c-quoted", and (3) change the core.quotePath description to refer to "c-quote" in the glossary.

But I am not sure it that makes the resulting document easier to use by the end users. I personally find the result of applying the patch you posted easier.