Fix over-simplified documentation for 'git log -z'
authorBjörn Gustavsson <bgustavsson@gmail.com>
Mon, 23 Nov 2009 07:40:24 +0000 (08:40 +0100)
committerJunio C Hamano <gitster@pobox.com>
Mon, 23 Nov 2009 09:21:51 +0000 (01:21 -0800)
In commit 64485b4a, the documentation for 'git log -z' was
simplified too much. The -z option actually changes the behavior
of 'git log' in two ways: commits will be ended with a NUL
instead of a LF (correctly documented) and the --raw and
--numstat will have NUL as field terminators (omitted in
the documentation for 'git log').

Signed-off-by: Björn Gustavsson <bgustavsson@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/diff-options.txt

index 18366b1be60a61beed16dd67fcab6151b4ecd55e..8707d0e7404543d0565d72566a8db5946d9467ee 100644 (file)
@@ -87,19 +87,21 @@ endif::git-format-patch[]
 ifndef::git-format-patch[]
 
 -z::
+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` or `--numstat` 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.
-endif::git-log[]
-
-ifdef::git-log[]
-       Separate the commits with NULs instead of with new newlines.
-endif::git-log[]
 
 --name-only::
        Show only names of changed files.