summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Đoàn Trần Công Danh <congdanhqx@gmail.com>2021-06-08 08:58:40 +0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2021-06-08 13:34:48 +0900
commita0538e5c8baf9985a71d18a1495985441041efba (patch)
tree30a081c9c3e0494ab93d185209d00f19998fcdc6
parentGit 2.31.1 (diff)
downloadtgif-a0538e5c8baf9985a71d18a1495985441041efba.tar.xz
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 <zen96285@gmail.com> Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-log.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 1bbf865a1b..0498e7bacb 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -39,7 +39,9 @@ OPTIONS
full ref name (including prefix) will be printed. If 'auto' is
specified, then if the output is going to a terminal, the ref names
are shown as if 'short' were given, otherwise no ref names are
- shown. The default option is 'short'.
+ shown. The option `--decorate` is short-hand for `--decorate=short`.
+ Default to configuration value of `log.decorate` if configured,
+ otherwise, `auto`.
--decorate-refs=<pattern>::
--decorate-refs-exclude=<pattern>::