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

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

From
Mirko Faina <mroik@delayed.space>
Date
Mar 27, 2026, 00:20 UTC
Message-ID
<acXM3e23Us-mJxeE@exploit>
In-Reply-To
<xmqqo6kanvpn.fsf@gitster.g>
On Thu, Mar 26, 2026 at 02:10:12PM -0700, Junio C Hamano wrote:
Show 23 quoted lines
> 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
Previous: Junio C HamanoNext: Mirko Faina
Message 7 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.