diff options
| author | Junio C Hamano <gitster@pobox.com> | 2015-01-16 01:32:57 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-01-16 01:38:58 (GMT) |
| commit | b4a56a3966e3da8f8c369f8f5674233d34d94999 (patch) | |
| tree | fe9fb60ac52a6aef7b3b3b0007fac26a27d3defe /Documentation | |
| parent | fdf96a20acf96a6ac538df8113b2aafd6ed71d50 (diff) | |
| download | git-b4a56a3966e3da8f8c369f8f5674233d34d94999.zip git-b4a56a3966e3da8f8c369f8f5674233d34d94999.tar.gz git-b4a56a3966e3da8f8c369f8f5674233d34d94999.tar.bz2 | |
"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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/pretty-options.txt | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 8569e29..74aa01a 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, + 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]). |