[PATCH 1/2 v3] git-fast-import.txt: improve documentation for quoted paths
- From
Matthieu Moy <matthieu.moy@imag.fr>
- Date
- Nov 29, 2012, 19:11 UTC
- Message-ID
- <1354216293-21921-1-git-send-email-Matthieu.Moy@imag.fr>
- In-Reply-To
- <20121129185404.GC17309@sigill.intra.peff.net>
The documentation mentionned only newlines and double quotes as characters needing escaping, but the backslash also needs it. Also, the documentation was not clearly saying that double quotes around the file name were required (double quotes in the examples could be interpreted as part of the sentence, not part of the actual string).
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> --- cut-and-paste of Peff's version, adapted from mine.
Documentation/git-fast-import.txt | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 959e4d3..d1844ea 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -562,8 +562,12 @@ A `<path>` string must use UNIX-style directory separators (forward slash `/`), may contain any byte other than `LF`, and must not start with double quote (`"`). -If an `LF` or double quote must be encoded into `<path>` shell-style -quoting should be used, e.g. `"path/with\n and \" in it"`. +A path can use 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, the complete name should be surrounded with +double quotes, and any `LF`, backslash, or double quote characters +must be escaped by preceding them with a backslash (e.g., +`"path/with\n, \\ and \" in it"`). The value of `<path>` must be in canonical form. That is it must not:
-- 1.8.0.319.g8abfee4