SubmittingPatches: tags -> trailers

Commit Message

Kristoffer Haugsbakk Oct. 20, 2024, 4:57 p.m. UTC

From: Kristoffer Haugsbakk <[e-mail]>

“Trailer” is the preferred nomenclature in this project.  Also add a
definite article where I think it makes sense.

As we can see the rest of the document already prefers this term.  This
just gets rid of the last stragglers.

Signed-off-by: Kristoffer Haugsbakk <[e-mail]>
---

Notes (series):
    Commit message:
    
      “ “Trailer” is the preferred nomenclature in this project.
    
    Must surely be true since git-interpret-trailers(1) does not even
    contain the string “tag”.
    
    I did a grep in this directory:
    
        git grep tags ':(exclude)RelNotes'
    
    It didn’t look like there were any other mentions of “tags” in this
    sense.  Of course it was difficult to look through.
    
    +CC: Josh Soref <[e-mail]> based on
    e.g. ac9fff2bf1c (SubmittingPatches: discourage new trailers,
    2023-12-28)

 Documentation/SubmittingPatches | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)


base-commit: 34b6ce9b30747131b6e781ff718a45328aa887d0

Comments

Josh Soref Oct. 20, 2024, 9:29 p.m. UTC | #1

Kristoffer Haugsbakk wrote:
> “Trailer” is the preferred nomenclature in this project.  Also add a
> definite article where I think it makes sense.
>
> As we can see the rest of the document already prefers this term.  This
> just gets rid of the last stragglers.
>
> Signed-off-by: Kristoffer Haugsbakk <[e-mail]>
> ---
>
> Notes (series):
>     Commit message:
>
>       “ “Trailer” is the preferred nomenclature in this project.
>
>     Must surely be true since git-interpret-trailers(1) does not even
>     contain the string “tag”.
>
>     I did a grep in this directory:
>
>         git grep tags ':(exclude)RelNotes'
>
>     It didn’t look like there were any other mentions of “tags” in this
>     sense.  Of course it was difficult to look through.
>
>     +CC: Josh Soref <[e-mail]> based on
>     e.g. ac9fff2bf1c (SubmittingPatches: discourage new trailers,
>     2023-12-28)

This change makes sense to me.

Taylor Blau Oct. 21, 2024, 9:22 p.m. UTC | #2

On Sun, Oct 20, 2024 at 05:29:14PM -0400, Josh Soref wrote:
> Kristoffer Haugsbakk wrote:
> > “Trailer” is the preferred nomenclature in this project.  Also add a
> > definite article where I think it makes sense.
> >
> > As we can see the rest of the document already prefers this term.  This
> > just gets rid of the last stragglers.
> >
> > Signed-off-by: Kristoffer Haugsbakk <[e-mail]>
> > ---
> >
> > Notes (series):
> >     Commit message:
> >
> >       “ “Trailer” is the preferred nomenclature in this project.
> >
> >     Must surely be true since git-interpret-trailers(1) does not even
> >     contain the string “tag”.
> >
> >     I did a grep in this directory:
> >
> >         git grep tags ':(exclude)RelNotes'
> >
> >     It didn’t look like there were any other mentions of “tags” in this
> >     sense.  Of course it was difficult to look through.
> >
> >     +CC: Josh Soref <[e-mail]> based on
> >     e.g. ac9fff2bf1c (SubmittingPatches: discourage new trailers,
> >     2023-12-28)
>
> This change makes sense to me.

To me as well. Thanks, both. Will queue.

Thanks,
Taylor

Patch

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index d8a8caa7916..db17bc7fe2c 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -412,13 +412,13 @@  Also notice that a real name is used in the `Signed-off-by` trailer. Please
 don't hide your real name.
 
 [[commit-trailers]]
-If you like, you can put extra tags at the end:
+If you like, you can put extra trailers at the end:
 
 . `Reported-by:` is used to credit someone who found the bug that
   the patch attempts to fix.
 . `Acked-by:` says that the person who is more familiar with the area
   the patch attempts to modify liked the patch.
-. `Reviewed-by:`, unlike the other tags, can only be offered by the
+. `Reviewed-by:`, unlike the other trailers, can only be offered by the
   reviewers themselves when they are completely satisfied with the
   patch after a detailed analysis.
 . `Tested-by:` is used to indicate that the person applied the patch
@@ -436,7 +436,7 @@  While you can also create your own trailer if the situation warrants it, we
 encourage you to instead use one of the common trailers in this project
 highlighted above.
 
-Only capitalize the very first letter of tags, i.e. favor
+Only capitalize the very first letter of the trailer, i.e. favor
 "Signed-off-by" over "Signed-Off-By" and "Acked-by:" over "Acked-By".
 
 [[git-tools]]