[PATCH] doc/log: correct default for --decorate
- From
Đoàn Trần Công Danh <congdanhqx@gmail.com>
- Date
- Jun 8, 2021, 01:58 UTC
- Message-ID
- <20210608015840.24532-1-congdanhqx@gmail.com>
- In-Reply-To
- <pull.1030.git.git.1622440856607.gitgitgadget@gmail.com>
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> ---
I'm reluctant to send this out since I would like to see Andy get familiar with the list. However, it's a while since the original patch.
Documentation/git-log.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
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>::
-- 2.32.0.5.gc7fdd17fde