[PATCH v3 0/5] SubmittingPatches: update and flesh out trailer sections

[kristofferhaugsbakk@fastmail.com]

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Topic name (applied) kh/submittingpatches-trailers

Topic summary: Flesh out and update the trailer sections.

All of these points have come up on the mailing list. At least for me.
And `Based-on-patch-by` is a nice-to-have documented kind of thing.

[elide “since January” from v1...]

Link to v2: https://lore.kernel.org/git/V2_CV_SubPatches_trailers.9b6@msgid.xyz/

§ Changes in v3

Patch “encourage trailer use for substantial help”: correct AsciiDoc anchor
placement.

[1/5] SubmittingPatches: encourage trailer use for substantial help
[2/5] SubmittingPatches: discourage common Linux trailers
[3/5] SubmittingPatches: document Based-on-patch-by trailer
[4/5] SubmittingPatches: be consistent with trailer markup
[5/5] SubmittingPatches: note that trailer order matters

 Documentation/SubmittingPatches | 46 ++++++++++++++++++++++++++-------
 1 file changed, 36 insertions(+), 10 deletions(-)

Interdiff against v2:
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index dceeb5a1817..56706e55ea1 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -447,8 +447,8 @@ identifying, and not misleading.
 The goal of this policy is to allow us to have sufficient information to contact
 you if questions arise about your contribution.
 
-=== Commit trailers
 [[commit-trailers]]
+=== Commit trailers
 It is polite to credit people who have helped with your work to a
 substantial enough degree. This project uses commit trailers for that,
 where the credited person is written out like a Git author, i.e. with
Range-diff against v2:
1:  835eb736f39 ! 1:  dc75b862d73 SubmittingPatches: encourage trailer use for substantial help
    @@ Commit message
         Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
     
      ## Documentation/SubmittingPatches ##
    -@@ Documentation/SubmittingPatches: identifying, and not misleading.
    - The goal of this policy is to allow us to have sufficient information to contact
    +@@ Documentation/SubmittingPatches: The goal of this policy is to allow us to have sufficient information to contact
      you if questions arise about your contribution.
      
    -+=== Commit trailers
      [[commit-trailers]]
     -If you like, you can put extra trailers at the end:
    ++=== Commit trailers
     +It is polite to credit people who have helped with your work to a
     +substantial enough degree. This project uses commit trailers for that,
     +where the credited person is written out like a Git author, i.e. with
2:  5a652b8e14d = 2:  86b9973a8e8 SubmittingPatches: discourage common Linux trailers
3:  5e53999b2e9 = 3:  a142f66c3b8 SubmittingPatches: document Based-on-patch-by trailer
4:  dd47fabe917 = 4:  439fa864da7 SubmittingPatches: be consistent with trailer markup
5:  726386d976b = 5:  2d133f2ad5e SubmittingPatches: note that trailer order matters

base-commit: 1ff279f3404a482a83fb04c7457e41ab26884aea
-- 
2.54.0.22.g9e26862b904