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

Re: [PATCH 11/11] doc: trailer: add more examples in DESCRIPTION

From
Junio C Hamano <gitster@pobox.com>
Date
May 8, 2023, 19:50 UTC
Message-ID
<xmqqmt2emwlj.fsf@gitster.g>
In-Reply-To
<ea483b364b460819c727da5c65497de6ecd4b04f.1683566870.git.gitgitgadget@gmail.com>
"Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 34 quoted lines
> From: Linus Arver <linusa@google.com>
>
> Be more up-front about what trailers are in practice with examples, to
> give the reader a visual cue while they go on to read the rest of the
> description.
>
> Also add an example for multiline values.
>
> Signed-off-by: Linus Arver <linusa@google.com>
> ---
>  Documentation/git-interpret-trailers.txt | 20 ++++++++++++++++++--
>  1 file changed, 18 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
> index 119dcd64f34..f31b94a6823 100644
> --- a/Documentation/git-interpret-trailers.txt
> +++ b/Documentation/git-interpret-trailers.txt
> @@ -16,7 +16,18 @@ DESCRIPTION
>  -----------
>  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.
> +message. For example, in the following commit message
> +
> +------------------------------------------------
> +subject
> +
> +message
> +
> +Signed-off-by: Alice <alice@example.com>
> +Signed-off-by: Bob <bob@example.com>
> +------------------------------------------------
> +
> +the last two lines starting with "Signed-off-by" are trailers.
Excellent.
Show 11 quoted lines
> @@ -68,7 +79,12 @@ When reading trailers, there can be no whitespace before or inside the
>  between the <token> and the separator. There can be whitespaces before,
>  inside or after the <value>. The <value> may be split over multiple lines
>  with each subsequent line starting with at least one whitespace, like
> -the "folding" in RFC 822.
> +the "folding" in RFC 822. Example:
> +
> +------------------------------------------------
> +token: Lorem ipsum dolor sit amet, consectetur
> +  adipiscing elit.
> +------------------------------------------------
Excellent.
Previous: Linus Arver via GitGitGadgetNext: Junio C Hamano
Message 29 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.