"log --pretty" documentation: do not forget "tformat:"
authorJunio C Hamano <gitster@pobox.com>
Fri, 16 Jan 2015 01:32:57 +0000 (17:32 -0800)
committerJunio C Hamano <gitster@pobox.com>
Fri, 16 Jan 2015 01:38:58 +0000 (17:38 -0800)
We forgot to list "tformat:<string>" when enumerating possible
values that "--pretty=<format>" can take. It was not described
that "--pretty='string with %s placeholder'" that is not understood
is DWIMmed as "--pretty=tformat:<that string>".

Further, it was unclear what "When omitted, defaults to 'medium'"
was meant. Is it "When --pretty=<something> was not given at all",
or is it "When --pretty is given without =<something>"? Clarify
that it is the latter.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/pretty-options.txt
index 8569e29d08784cb5eb053af919e4b7514b1c296b..74aa01a0ec27b6cc0fbb9763b8e583a3f996da25 100644 (file)
@@ -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,
+       and has '%placeholder' in it, it acts as if
+       '--pretty=tformat:<format>' were given.
++
+See the "PRETTY FORMATS" section for some additional details for each
+format.  When '=<format>' part is omitted, it defaults to 'medium'.
 +
 Note: you can specify the default pretty format in the repository
 configuration (see linkgit:git-config[1]).