mirror of
https://github.com/git/git
synced 2024-08-25 02:35:46 +00:00
"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 <gitster@pobox.com>
This commit is contained in:
parent
fdf96a20ac
commit
b4a56a3966
|
@ -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]).
|
||||
|
|
Loading…
Reference in a new issue