Re: cosmetic bug: "git show --pretty:format" produces different output than "git show --format"
From: Junio C Hamano <hidden>
Date: 2016-06-15 23:03:35
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Possibly related (same subject, not in this thread)
- 2016-06-15 · cosmetic bug: "git show --pretty:format" produces different output than "git show --format" · Francesc Zacarias <hidden>
- 2016-06-15 · Re: cosmetic bug: "git show --pretty:format" produces different output than "git show --format" · Michael J Gruber <hidden>
- 2016-06-15 · Re: cosmetic bug: "git show --pretty:format" produces different output than "git show --format" · Junio C Hamano <hidden>
Michael J Gruber [off-list ref] writes:
The first part of the man page is a bit sloppy, but refers to the FORMAT section. There, it says that "--pretty" is equivalent to "--pretty=tformat:" which is different from "--pretty=format:".
It is indeed sloppy. It says --(pretty|format)=<format> can take these canned <format>s or 'format:<string>', but - it does not say it can also take 'tformat:<string>' at all; and - it does not say a <format> that is none of the above is dwimmed with 'tformat:' prefixed. Perhaps something like this is needed. Documentation/pretty-options.txt | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 8569e29..7e17af9 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt@@ -3,9 +3,13 @@ Pretty-print the contents of the commit logs in a given format, where '<format>' can be one of 'oneline', 'short', 'medium', - 'full', 'fuller', 'email', 'raw' and 'format:<string>'. See - the "PRETTY FORMATS" section for some additional details for each - format. When omitted, the format defaults to 'medium'. + 'full', 'fuller', 'email', 'raw', 'format:<string>' + and 'tformat:<string>'. When '<format>' is none of the above, + acts as if '--pretty=tformat:<format>' were given. ++ +See +the "PRETTY FORMATS" section for some additional details for each +format. When omitted, the format defaults to 'medium'. + Note: you can specify the default pretty format in the repository configuration (see linkgit:git-config[1]).