From: Đoàn Trần Công Danh Date: Mon, 31 May 2021 07:18:23 GMT Subject: Re: [PATCH] describe-doc:fix a obscure error description in the git log documentation Message-ID: In-Reply-To: On 2021-05-31 15:57:17+0900, Junio C Hamano wrote: > > I think you meant: > > > > git log -1 >/tmp/no-decorate > > Yes, and this (with redirection to file), I think you do not get any > decoration---that is what you get from --decorate=auto, i.e. > > git log --decorate=auto -1 >/tmp/auto-decorate > > I think the default discussed in the paragraph the patch touches is > "what happens if you do not say what kind, i.e. "--decorate" not > "--decorate=", so "the default is 'short'" is correct, > but at the same time, "even if you do not say --decorate, you'll see > short decoration when on a terminal" is worth mentioning somewhere. I forgot that I have log.decorate configured to 'short'. *facepalm* I think something like this should be nice. ----8<---- 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=:: --decorate-refs-exclude=:: ---->8--------- Andy, feel free to pick this up and re-wording however you like. -- Danh