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

Re: [PATCH 2/3] Doc: add more detail for git-format-patch

From
Junio C Hamano <gitster@pobox.com>
Date
Aug 20, 2019, 19:01 UTC
Message-ID
<xmqq1rxfveym.fsf@gitster-ct.c.googlers.com>
In-Reply-To
<7619da962d1fc804392e3552fbd56bf4bc68ac38.1566182184.git.liu.denton@gmail.com>
Denton Liu <liu.denton@gmail.com> writes:
Show 11 quoted lines
> Next, while we're at it, surround option arguments with <>.
> ...
>  		   [--start-number <n>] [--numbered-files]
> -		   [--in-reply-to=Message-Id] [--suffix=.<sfx>]
> +		   [--in-reply-to=<Message-Id>] [--suffix=.<sfx>]
>  		   [--ignore-if-in-upstream]
> -		   [--rfc] [--subject-prefix=Subject-Prefix]
> +		   [--rfc] [--subject-prefix=<Subject-Prefix>]
> ...
> ---in-reply-to=Message-Id::
> +--in-reply-to=<Message-Id>::

That is a good change, but if we are making this change while are at it, I think we should fix it to read <message id>. "Message-Id" is a good spelling iff we are talking about the label on the left hand side of colon in e-mail header, but in this context, we are talking about the value to be placed on that header.

All the other multi-word placeholders in the SYNOPSIS section spell the words as normal multiple words separated with whitespace in lower case. You'd also want to fix the spelling of Subject-Prefix to <subject prefix> for consistency.

Thanks.
Previous: Denton LiuNext: Denton Liu
Message 5 of 9 in “format-patch: teach --infer-cover-subject option”
  1. 0/3 format-patch: teach --infer-cover-subject optionDenton Liu, Aug 19, 2019
  2. 2/3 Doc: add more detail for git-format-patchDenton Liu, Aug 19, 2019
  3. Eric SunshineAug 19, 2019
  4. Denton LiuAug 19, 2019
  5. Junio C HamanoAug 20, 2019
  6. 3/3 format-patch: infer cover letter from branch descriptionDenton Liu, Aug 19, 2019
  7. Eric SunshineAug 19, 2019
  8. 1/3 t4014: clean up styleDenton Liu, Aug 19, 2019
  9. Eric SunshineAug 19, 2019

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.