Skip to content

Commit b4a56a3

Browse files
committed
"log --pretty" documentation: do not forget "tformat:"
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 <[email protected]>
1 parent fdf96a2 commit b4a56a3

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

Documentation/pretty-options.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@
33

44
Pretty-print the contents of the commit logs in a given format,
55
where '<format>' can be one of 'oneline', 'short', 'medium',
6-
'full', 'fuller', 'email', 'raw' and 'format:<string>'. See
7-
the "PRETTY FORMATS" section for some additional details for each
8-
format. When omitted, the format defaults to 'medium'.
6+
'full', 'fuller', 'email', 'raw', 'format:<string>'
7+
and 'tformat:<string>'. When '<format>' is none of the above,
8+
and has '%placeholder' in it, it acts as if
9+
'--pretty=tformat:<format>' were given.
10+
+
11+
See the "PRETTY FORMATS" section for some additional details for each
12+
format. When '=<format>' part is omitted, it defaults to 'medium'.
913
+
1014
Note: you can specify the default pretty format in the repository
1115
configuration (see linkgit:git-config[1]).

0 commit comments

Comments
 (0)