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

Re: [PATCH] Documentation: explain "mboxrd" pretty format

From
Junio C Hamano <gitster@pobox.com>
Date
Apr 17, 2020, 02:00 UTC
Message-ID
<xmqqzhbax44l.fsf@gitster.c.googlers.com>
In-Reply-To
<20200417014713.GA20574@pluvano.com>
Emma Brooks <me@pluvano.com> writes:
Show 19 quoted lines
> On 2020-04-15 22:03:36-0700, Junio C Hamano wrote:
>> > +Like 'email', but lines in the commit message starting with "From "
>> > +(preceded by zero or more ">") are quoted with ">" so they aren't
>> > +confused as starting a new commit.
>> 
>> I am torn between rephrasing "starting a new commit" with "starting
>> a new e-mail message", and keeping it as-is.  Technically, the latter
>> is more correct---the >From quoting is a technique to avoid starting
>> a line with "From " in a reversible way, as pieces of e-mails in a
>> single mailbox file needs to be split at the boundary.  But in the
>> context of format-patch, perhaps saying each "record" in the output
>> file is a "commit" (not a piece of e-mail message) would probably be
>> an acceptable white lie.
>
> While it is more accurate to say "starting a new email" rather than
> "commit", I think it might be less confusing to say "starting a new
> commit", if the reader isn't already familiar with how mbox works or its
> variants, since the pretty formats control commit display and would
> typically be thought about in terms of commits rather than emails.

Exactly. That is why I said that I was torn between technical correctness and tool-specific description. "torn between" is quite different from "inclined to prefer the one different from yours" ;-)

Previous: Emma Brooks
Message 5 of 5 in “Documentation: explain "mboxrd" pretty format”
  1. Documentation: explain "mboxrd" pretty formatEmma Brooks, Apr 16, 2020
  2. Eric WongApr 16, 2020
  3. Junio C HamanoApr 16, 2020
  4. Emma BrooksApr 17, 2020
  5. Junio C HamanoApr 17, 2020

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.