Allow custom "comment char"
[gitweb.git] / Documentation / git-fast-import.txt
index 959e4d3aee2c616ec9b12cf84865ade2f2ef7206..3da5cc272a7aac921017fead83c271b5d35fd977 100644 (file)
@@ -39,10 +39,6 @@ OPTIONS
        See ``Date Formats'' below for details about which formats
        are supported, and their syntax.
 
--- done::
-       Terminate with error if there is no 'done' command at the
-       end of the stream.
-
 --force::
        Force updating modified existing branches, even if doing
        so would cause commits to be lost (as the new commit does
@@ -108,7 +104,8 @@ OPTIONS
        output.
 
 --done::
-       Require a `done` command at the end of the stream.
+       Terminate with error if there is no `done` command at the
+       end of the stream.
        This option might be useful for detecting errors that
        cause the frontend to terminate before it has started to
        write a stream.
@@ -427,7 +424,7 @@ they made it.
 
 Here `<name>` is the person's display name (for example
 ``Com M Itter'') and `<email>` is the person's email address
-(``cm@example.com'').  `LT` and `GT` are the literal less-than (\x3c)
+(``\cm@example.com'').  `LT` and `GT` are the literal less-than (\x3c)
 and greater-than (\x3e) symbols.  These are required to delimit
 the email address from the other fields in the line.  Note that
 `<name>` and `<email>` are free-form and may contain any sequence
@@ -562,8 +559,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: