diff options
| author | Matthieu Moy <Matthieu.Moy@imag.fr> | 2012-11-29 20:11:32 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-11-29 11:49:51 -0800 |
| commit | 7c65b2ebb72fcf9b563be3367a088256757343a6 (patch) | |
| tree | ec311a89dfe2cc9422c5f28ce847a29ade6b4c5b /Documentation/git-fast-import.txt | |
| parent | 462d97daf69951f968f16b6271de9db34f7dd13c (diff) | |
| download | git-7c65b2ebb72fcf9b563be3367a088256757343a6.tar.gz | |
git-fast-import.txt: improve documentation for quoted paths
The documentation mentioned 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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-fast-import.txt')
| -rw-r--r-- | Documentation/git-fast-import.txt | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 959e4d3aee..d1844ead4a 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: |