[PATCH 1/2] git-fast-import.txt: improve documentation for quoted paths
- From
Matthieu Moy <matthieu.moy@imag.fr>
- Date
- Nov 29, 2012, 17:00 UTC
- Message-ID
- <1354208455-21228-1-git-send-email-Matthieu.Moy@imag.fr>
- In-Reply-To
- <vpq624omjn4.fsf@grenoble-inp.fr>
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> --- Documentation/git-fast-import.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 6603a7a..35b909c 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -558,8 +558,9 @@ 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"`. +If an `LF`, backslash or double quote must be encoded into `<path>` +shell-style quoting should be used, and the complete name should be +surrounded with double quotes 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