From: "Đoàn Trần Công Danh" <congdanhqx@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Andy AO via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org, Bagas Sanjaya <bagasdotme@gmail.com>,
Felipe Contreras <felipe.contreras@gmail.com>,
"Robert P. J. Day" <rpjday@crashcourse.ca>,
Derrick Stolee <stolee@gmail.com>, Andy AO <zen96285@gmail.com>
Subject: Re: [PATCH] describe-doc:fix a obscure error description in the git log documentation
Date: Mon, 31 May 2021 14:18:23 +0700 [thread overview]
Message-ID: <YLSNv8Xw3SVzYm8r@danh.dev> (raw)
In-Reply-To: <xmqqmtsbv19u.fsf@gitster.g>
On 2021-05-31 15:57:17+0900, Junio C Hamano <gitster@pobox.com> 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=<what kind>", 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=<pattern>::
--decorate-refs-exclude=<pattern>::
---->8---------
Andy, feel free to pick this up and re-wording however you like.
--
Danh
next prev parent reply other threads:[~2021-05-31 7:18 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-31 6:00 [PATCH] describe-doc:fix a obscure error description in the git log documentation Andy AO via GitGitGadget
2021-05-31 6:41 ` Bagas Sanjaya
2021-05-31 6:47 ` Đoàn Trần Công Danh
2021-05-31 6:57 ` Junio C Hamano
2021-05-31 7:18 ` Đoàn Trần Công Danh [this message]
2021-05-31 7:49 ` Bagas Sanjaya
2021-05-31 10:00 ` Đoàn Trần Công Danh
2021-06-08 1:58 ` [PATCH] doc/log: correct default for --decorate Đoàn Trần Công Danh
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=YLSNv8Xw3SVzYm8r@danh.dev \
--to=congdanhqx@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=rpjday@crashcourse.ca \
--cc=stolee@gmail.com \
--cc=zen96285@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).