From: Junio C Hamano <gitster@pobox.com>
To: Mirko Faina <mroik@delayed.space>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] docs: fix --commit-list-format related entries
Date: Thu, 26 Mar 2026 12:10:08 -0700 [thread overview]
Message-ID: <xmqqpl4qpfu7.fsf@gitster.g> (raw)
In-Reply-To: <20260326185541.17523-1-mroik@delayed.space> (Mirko Faina's message of "Thu, 26 Mar 2026 19:55:41 +0100")
Mirko Faina <mroik@delayed.space> writes:
> The user is allowed to drop the prefix if the format-string contains a
> `%<placeholder>`.
As you do not, and we do not want to, parse and validate
placeholder, it is more honest to phrase this like
A format-string that contains a `%` letter is treated as a
custom format even if it lacks the `log:` prefix.
even if we omit saying ", expecting that '%' is part of a %<prefix>",
or ", similar to how `git log --pretty=<format>` works as if the
<format> were prefixed with `format:`".
> - If not given, defaults to the `format.commitListFormat` configuration
> - variable.
> - This option implies the use of `--cover-letter` unless
> - `--no-cover-letter` is given.
> + If not given, defaults to `shortlog` unless the
> + `format.commitListFormat` configuration variable is set. This option
> + implies the use of `--cover-letter` unless `--no-cover-letter` is
> + given.
A new reader would wonder if setting the configuration variable
would count as a trigger to "This option implies", even though we
only want an explicit command line option to do so.
Here is myu attempt to rephrase it, but
Use of this option from the command line implies `--cover-letter`;
an explicit `--no-cover-letter` can defeat it.
I am not sure how much better it is from the original.
next prev parent reply other threads:[~2026-03-26 19:10 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 [this message]
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
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=xmqqpl4qpfu7.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=mroik@delayed.space \
/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