Documentation improvements for the description of short format.
[gitweb.git] / Documentation / diff-options.txt
index 2b37193a37da9715b0ae4b8aa47c85064694ef8e..a1191d647bfb4685701e47de794bf14964de0088 100644 (file)
@@ -85,10 +85,23 @@ ifndef::git-format-patch[]
 endif::git-format-patch[]
 
 ifndef::git-format-patch[]
+
 -z::
-       NUL-line termination on output.  This affects the `--raw`
-       output field terminator.  Also output from commands such
-       as `git-log` will be delimited with NUL between commits.
+ifdef::git-log[]
+       Separate the commits with NULs instead of with new newlines.
++
+Also, when `--raw` or `--numstat` has been given, do not munge
+pathnames and use NULs as output field terminators.
+endif::git-log[]
+ifndef::git-log[]
+       When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
+       given, do not munge pathnames and use NULs as output field terminators.
+endif::git-log[]
++
+Without this option, each pathname output will have TAB, LF, double quotes,
+and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
+respectively, and the pathname will be enclosed in double quotes if
+any of those replacements occurred.
 
 --name-only::
        Show only names of changed files.