Skip to content

Commit a0538e5

Browse files
sgngitster
authored andcommitted
doc/log: correct default for --decorate
There're two different default options for log --decorate: * Should `--decorate` be given without any arguments, it's default to `short` * Should neither `--decorate` nor `--no-decorate` be given, it's default to the `log.decorate` or `auto`. We documented the former, but not the latter. Let's document them, too. Reported-by: Andy AO <[email protected]> Signed-off-by: Đoàn Trần Công Danh <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 48bf2fa commit a0538e5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Documentation/git-log.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ OPTIONS
3939
full ref name (including prefix) will be printed. If 'auto' is
4040
specified, then if the output is going to a terminal, the ref names
4141
are shown as if 'short' were given, otherwise no ref names are
42-
shown. The default option is 'short'.
42+
shown. The option `--decorate` is short-hand for `--decorate=short`.
43+
Default to configuration value of `log.decorate` if configured,
44+
otherwise, `auto`.
4345

4446
--decorate-refs=<pattern>::
4547
--decorate-refs-exclude=<pattern>::

0 commit comments

Comments
 (0)