From: Mirko Faina <mroik@delayed.space>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Mirko Faina <mroik@delayed.space>
Subject: Re: [PATCH v2] docs: fix --commit-list-format related entries
Date: Fri, 27 Mar 2026 01:20:59 +0100 [thread overview]
Message-ID: <acXM3e23Us-mJxeE@exploit> (raw)
In-Reply-To: <xmqqo6kanvpn.fsf@gitster.g>
On Thu, Mar 26, 2026 at 02:10:12PM -0700, Junio C Hamano wrote:
> Mirko Faina <mroik@delayed.space> writes:
>
> > On Thu, Mar 26, 2026 at 01:45:15PM -0700, Junio C Hamano wrote:
> >> Being verbose is usually a good way to discourage readers from
> >> reading.
> > ...
> >> The use of this command line option implies `--cover-letter`,
> >> unless explicitly countermanded with `--no-cover-letter`.
> >
> > this part in particular is no different than the original text:
> >
> > This option implies the use of `--cover-letter` unless
> > `--no-cover-letter` is given.
> >
> > If we want to emphasize that the configuration variable doesn't imply
> > --cover-letter, we have to add the note on `format.commitListFormat`.
>
> I do not think so.
>
> If we mention a variable, the readers would wonder if the variable
> has effects. You can explicitly say that that it does *not* have
> effect, but we are often better of not mentioning what is not
> relevant.
So the issue with the original is simply the fact that it wasn't
explicitly said from the command line? If that's the case then the v2
should be fine but without the note about the configuration variable,
i.e. "This option given from the command-line implies the use of
`--cover-letter` unless `--no-cover-letter` is given."
Thank you
next prev parent reply other threads:[~2026-03-27 0:21 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-26 18:55 [PATCH] docs: fix --commit-list-format related entries Mirko Faina
2026-03-26 19:10 ` Junio C Hamano
2026-03-26 20:06 ` [PATCH v2] " Mirko Faina
2026-03-26 20:45 ` Junio C Hamano
2026-03-26 20:53 ` Mirko Faina
2026-03-26 21:10 ` Junio C Hamano
2026-03-27 0:20 ` Mirko Faina [this message]
2026-03-27 0:25 ` Mirko Faina
2026-03-27 19:48 ` [PATCH 0/2] format-patch: remove wrapping and update docs Mirko Faina
2026-03-27 19:48 ` [PATCH 1/2] docs: fix --commit-list-format related entries Mirko Faina
2026-03-27 19:48 ` [PATCH 2/2] format-patch: removing unconditional wrapping Mirko Faina
2026-03-27 20:27 ` Junio C Hamano
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=acXM3e23Us-mJxeE@exploit \
--to=mroik@delayed.space \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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