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

Re: [PATCH v3 3/9] doc: trailer: drop "commit message part" phrasing

From
Christian Couder <christian.couder@gmail.com>
Date
Jun 14, 2023, 15:00 UTC
Message-ID
<CAP8UFD2iej1EhUtR=+wqcnnoYrwCPFoR2ed71Wswyd8CYPthFA@mail.gmail.com>
In-Reply-To
<e0a56c8e61d80ef345885bf266e9844de289695f.1686017304.git.gitgitgadget@gmail.com>

On Tue, Jun 6, 2023 at 4:08 AM Linus Arver via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 49 quoted lines
>
> From: Linus Arver <linusa@google.com>
>
> The command can take inputs that are either just a commit message, or
> an email-like output such as git-format-patch which includes a commit
> message, "---" divider, and patch part. The existing explanation blends
> these two inputs together in the first sentence
>
>     This command reads some patches or commit messages
>
> which then necessitates using the "commit message part" phrasing (as
> opposed to just "commit message") because the input is ambiguous per the
> above definition.
>
> This change separates the two input types and explains them separately,
> and so there is no longer a need to use the "commit message part"
> phrase.
>
> Signed-off-by: Linus Arver <linusa@google.com>
> ---
>  Documentation/git-interpret-trailers.txt | 35 +++++++++++++-----------
>  1 file changed, 19 insertions(+), 16 deletions(-)
>
> diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
> index da8fec7d5fe..ffde97a6c3d 100644
> --- a/Documentation/git-interpret-trailers.txt
> +++ b/Documentation/git-interpret-trailers.txt
> @@ -18,17 +18,22 @@ Add or parse 'trailer' lines that look similar to RFC 822 e-mail
>  headers, at the end of the otherwise free-form part of a commit
>  message.
>
> -This command reads some patches or commit messages from either the
> -<file> arguments or the standard input if no <file> is specified. If
> -`--parse` is specified, the output consists of the parsed trailers.
> -
> +This command reads commit messages from either the
> +<file> arguments or the standard input if no <file> is specified.
> +If `--parse` is specified, the output consists of the parsed trailers.
>  Otherwise, this command applies the arguments passed using the
> -`--trailer` option, if any, to the commit message part of each input
> -file. The result is emitted on the standard output.
> +`--trailer` option, if any, to each input file. The result is emitted on the
> +standard output.
> +
> +This command can also operate on the output of linkgit:git-format-patch[1],
> +which is more elaborate than a plain commit message. Namely, such output
> +includes a commit message (as above), a "---" divider line, and a patch part.
> +For these inputs, the divider and patch parts are ignored, unless `--no-divider`
> +is specified.

I think saying "the divider and patch parts are ignored" is a bit ambiguous. It could mean that when a patch is read by the command only its commit message, possibly modified by the command, is emitted on the standard output.

I would suggest something like:

"For these inputs, the divider and patch parts are not modified by this command and are emitted as is on the output, unless `--no-divider` is specified."

Previous: Linus Arver via GitGitGadgetNext: Linus Arver
Message 49 of 73 in “docs: interpret-trailers: reword and add examples”
  1. 00/11 docs: interpret-trailers: reword and add examplesLinus Arver via GitGitGadget, May 8, 2023
  2. 01/11 doc: trailer: fix grammarLinus Arver via GitGitGadget, May 8, 2023
  3. Junio C HamanoMay 8, 2023
  4. Linus ArverMay 8, 2023
  5. Junio C HamanoMay 8, 2023
  6. 02/11 doc: trailer: swap verb orderLinus Arver via GitGitGadget, May 8, 2023
  7. Junio C HamanoMay 8, 2023
  8. 03/11 doc: trailer: --no-divider: more precise languageLinus Arver via GitGitGadget, May 8, 2023
  9. Junio C HamanoMay 8, 2023
  10. 05/11 doc: trailer: remove redundant phrasingLinus Arver via GitGitGadget, May 8, 2023
  11. 04/11 doc: trailer: explain "commit mesage part" on first usageLinus Arver via GitGitGadget, May 8, 2023
  12. Junio C HamanoMay 8, 2023
  13. Linus ArverMay 10, 2023
  14. 07/11 doc: trailer: use angle brackets for <token> and <value>Linus Arver via GitGitGadget, May 8, 2023
  15. Junio C HamanoMay 8, 2023
  16. 06/11 doc: trailer: trailer.<token>.cmd: add missing verb phraseLinus Arver via GitGitGadget, May 8, 2023
  17. Junio C HamanoMay 8, 2023
  18. Linus ArverMay 10, 2023
  19. Junio C HamanoMay 10, 2023
  20. 08/11 doc: trailer.<token>.command: refer to existing exampleLinus Arver via GitGitGadget, May 8, 2023
  21. Junio C HamanoMay 8, 2023
  22. Linus ArverMay 10, 2023
  23. Junio C HamanoMay 10, 2023
  24. 09/11 doc: trailer.<token>.command: emphasize deprecationLinus Arver via GitGitGadget, May 8, 2023
  25. Junio C HamanoMay 8, 2023
  26. Linus ArverMay 10, 2023
  27. 10/11 doc: trailer: mention 'key' in DESCRIPTIONLinus Arver via GitGitGadget, May 8, 2023
  28. 11/11 doc: trailer: add more examples in DESCRIPTIONLinus Arver via GitGitGadget, May 8, 2023
  29. Junio C HamanoMay 8, 2023
  30. Junio C HamanoMay 8, 2023
  31. Linus ArverMay 8, 2023
  32. 0/9 docs: interpret-trailers: reword and add examplesLinus Arver via GitGitGadget, May 11, 2023
  33. 1/9 doc: trailer: fix grammarLinus Arver via GitGitGadget, May 11, 2023
  34. 2/9 doc: trailer: swap verb orderLinus Arver via GitGitGadget, May 11, 2023
  35. 3/9 doc: trailer: drop "commit message part" phrasingLinus Arver via GitGitGadget, May 11, 2023
  36. 5/9 doc: trailer: remove redundant phrasingLinus Arver via GitGitGadget, May 11, 2023
  37. 6/9 doc: trailer: use angle brackets for <token> and <value>Linus Arver via GitGitGadget, May 11, 2023
  38. 4/9 doc: trailer: examples: avoid the word "message" by itselfLinus Arver via GitGitGadget, May 11, 2023
  39. 9/9 doc: trailer: add more examples in DESCRIPTIONLinus Arver via GitGitGadget, May 11, 2023
  40. 7/9 doc: trailer.<token>.command: emphasize deprecationLinus Arver via GitGitGadget, May 11, 2023
  41. 8/9 doc: trailer: mention 'key' in DESCRIPTIONLinus Arver via GitGitGadget, May 11, 2023
  42. Junio C HamanoMay 12, 2023
  43. Linus ArverMay 16, 2023
  44. Junio C HamanoMay 16, 2023
  45. 0/9 docs: interpret-trailers: reword and add examplesLinus Arver via GitGitGadget, Jun 6, 2023
  46. 1/9 doc: trailer: fix grammarLinus Arver via GitGitGadget, Jun 6, 2023
  47. 2/9 doc: trailer: swap verb orderLinus Arver via GitGitGadget, Jun 6, 2023
  48. 3/9 doc: trailer: drop "commit message part" phrasingLinus Arver via GitGitGadget, Jun 6, 2023
  49. Christian CouderJun 14, 2023
  50. Linus ArverJun 15, 2023
  51. 4/9 doc: trailer: examples: avoid the word "message" by itselfLinus Arver via GitGitGadget, Jun 6, 2023
  52. Christian CouderJun 14, 2023
  53. Linus ArverJun 15, 2023
  54. 5/9 doc: trailer: remove redundant phrasingLinus Arver via GitGitGadget, Jun 6, 2023
  55. 6/9 doc: trailer: use angle brackets for <token> and <value>Linus Arver via GitGitGadget, Jun 6, 2023
  56. 7/9 doc: trailer.<token>.command: emphasize deprecationLinus Arver via GitGitGadget, Jun 6, 2023
  57. 8/9 doc: trailer: mention 'key' in DESCRIPTIONLinus Arver via GitGitGadget, Jun 6, 2023
  58. Christian CouderJun 14, 2023
  59. Linus ArverJun 15, 2023
  60. 9/9 doc: trailer: add more examples in DESCRIPTIONLinus Arver via GitGitGadget, Jun 6, 2023
  61. Christian CouderJun 14, 2023
  62. Linus ArverJun 15, 2023
  63. Christian CouderJun 15, 2023
  64. 0/9 docs: interpret-trailers: reword and add examplesLinus Arver via GitGitGadget, Jun 15, 2023
  65. 1/9 doc: trailer: fix grammarLinus Arver via GitGitGadget, Jun 15, 2023
  66. 2/9 doc: trailer: swap verb orderLinus Arver via GitGitGadget, Jun 15, 2023
  67. 3/9 doc: trailer: drop "commit message part" phrasingLinus Arver via GitGitGadget, Jun 15, 2023
  68. 5/9 doc: trailer: remove redundant phrasingLinus Arver via GitGitGadget, Jun 15, 2023
  69. 4/9 doc: trailer: examples: avoid the word "message" by itselfLinus Arver via GitGitGadget, Jun 15, 2023
  70. 6/9 doc: trailer: use angle brackets for <token> and <value>Linus Arver via GitGitGadget, Jun 15, 2023
  71. 7/9 doc: trailer.<token>.command: emphasize deprecationLinus Arver via GitGitGadget, Jun 15, 2023
  72. 8/9 doc: trailer: mention 'key' in DESCRIPTIONLinus Arver via GitGitGadget, Jun 15, 2023
  73. 9/9 doc: trailer: add more examples in DESCRIPTIONLinus Arver via GitGitGadget, Jun 15, 2023

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.