Re: [PATCH 1/2] git-fast-import.txt: improve documentation for quoted paths

From: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Date: Nov 29, 2012, 18:47 UTC
Message-ID: <vpqhao8gsaj.fsf@grenoble-inp.fr>
In-Reply-To: <20121129181141.GA17309@sigill.intra.peff.net>

Jeff King <peff@peff.net> writes:

> So technically, your modification to the beginning of the sentence is
> not correct.

I'd say the resulting sentence is somehow incorrect, but not more than the previous one (both say "if ..." without really telling what the condition was).

>> If an `LF`, backslash or double quote must be encoded
>                        ^
>                        missing comma as list delimiter

Google tells me that my version was UK-correct but not US-correct. As french, I have no opinion on the subject, I take yours ;-).

How about this:

A path can use the C-style string quoting (this is accepted in all cases and mandatory if the filename starts with double quote or contains `LF`). In C-style quoting, `LF`, backslash, and double quote characters must be escaped by preceding them with a backslash. Also, the complete name should be surrounded with double quotes (e.g. `"path/with\n, \\ and \" in it"`).

This should be technically correct, and "this is accepted in all cases" should encourrage people to use it.

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