git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] docs: fix --commit-list-format related entries

From
Junio C Hamano <gitster@pobox.com>
Date
Mar 26, 2026, 19:10 UTC
Message-ID
<xmqqpl4qpfu7.fsf@gitster.g>
In-Reply-To
<20260326185541.17523-1-mroik@delayed.space>
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:`".

Show 8 quoted lines
> -	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.
Previous: Mirko FainaNext: Mirko Faina
Message 2 of 12 in “docs: fix --commit-list-format related entries”
  1. docs: fix --commit-list-format related entriesMirko Faina, Mar 26, 2026
  2. Junio C HamanoMar 26, 2026
  3. docs: fix --commit-list-format related entriesMirko Faina, Mar 26, 2026
  4. Junio C HamanoMar 26, 2026
  5. Mirko FainaMar 26, 2026
  6. Junio C HamanoMar 26, 2026
  7. Mirko FainaMar 27, 2026
  8. Mirko FainaMar 27, 2026
  9. 0/2 format-patch: remove wrapping and update docsMirko Faina, Mar 27, 2026
  10. 1/2 docs: fix --commit-list-format related entriesMirko Faina, Mar 27, 2026
  11. 2/2 format-patch: removing unconditional wrappingMirko Faina, Mar 27, 2026
  12. Junio C HamanoMar 27, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.