* [PATCH] Fix over-simplified documentation for 'git log -z'
@ 2009-11-23 7:40 Björn Gustavsson
0 siblings, 0 replies; only message in thread
From: Björn Gustavsson @ 2009-11-23 7:40 UTC (permalink / raw)
To: git; +Cc: Junio C Hamano
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>
---
I wrongly assumed that 'git log' ignores the --raw
and --numstat options, because I tested it in a repository
with only merge commits. They do have an effect for
plain commits, and consequently -z will modify their
behavior for 'git log' too.
This patch applies on 'next'.
Documentation/diff-options.txt | 12 +++++++-----
1 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 18366b1..8707d0e 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -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.
--
1.6.5.3.298.g39add
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2009-11-23 7:40 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-11-23 7:40 [PATCH] Fix over-simplified documentation for 'git log -z' Björn Gustavsson
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.