Git development
 help / color / mirror / Atom feed
From: Patrick Steinhardt <ps@pks.im>
To: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 2/6] SubmittingPatches: discuss non-ident trailers
Date: Wed, 17 Jun 2026 09:32:28 +0200	[thread overview]
Message-ID: <ajJNjOYMVDwL52zY@pks.im> (raw)
In-Reply-To: <43cd8c48-c933-4eef-a6c0-970c38885967@app.fastmail.com>

On Tue, Jun 16, 2026 at 10:02:46PM +0200, Kristoffer Haugsbakk wrote:
> On Fri, Jun 12, 2026, at 13:35, Patrick Steinhardt wrote:
> > On Thu, Jun 11, 2026 at 12:22:45AM +0200,
> > kristofferhaugsbakk@fastmail.com wrote:
> >> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> >> index 0b12badf86d..51c308a89a8 100644
> >> --- a/Documentation/SubmittingPatches
> >> +++ b/Documentation/SubmittingPatches
> >> @@ -474,7 +474,10 @@ These are the common trailers in use:
> >>
> >>  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.
> >> +highlighted above. A trailer that credits someone might be more likely
> >> +to be accepted since these are the most common ones. But another kind of
> >> +trailer might be relevant, for example to link to an issue tracker
> >> +belonging to a downstream project that is affected by a bug in Git.
> >
> > Hm, I wonder whether this is a bit too vague to really be helpful for a
> > newcomer. Instead of alluding to such trailers, wouldn't it be
> > preferable if we added those as actual examples to the list of known
> > trailers and then tell folks that they can invent their own ones if
> > there is a good reason to do so?
> 
> Honestly there are so few non-ident trailers that I don’t think they can
> be listed as common trailers:
> 
> 1. The Git project doesn’t need them (e.g. no bug tracker)
> 2. They seem mostly for use by other projects (bug trackers again)
> 
> With this list:
> 
>     git log --format='%(trailers:only,keyonly)' | sort | uniq
> 
> If you filter out the ident-looking ones:
> 
>     grep -v --extended-regexp -- '-[Bb]y$'
> 
> There are few left. And some can be discarded:
> 
> • Change-Id
> • Message-ID
> • Fixes (pointing to a commit)
> 
> So to address your point:
> 
> 1. Maybe this is so niche that it is not worth mentioning; or
> 2. Maybe give a concrete example like `Closes: <bug link>`?

Well, we don't use "Closes:" trailers, either. So I'd rather side with
your (1) and just not mention them at all.

Patrick

  reply	other threads:[~2026-06-17  7:32 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-10 22:22 [PATCH 0/6] SubmittingPatches: update and flesh out trailer sections kristofferhaugsbakk
2026-06-10 22:22 ` [PATCH 1/6] SubmittingPatches: encourage trailer use for substantial help kristofferhaugsbakk
2026-06-11 16:44   ` Junio C Hamano
2026-06-16 20:14     ` Kristoffer Haugsbakk
2026-06-10 22:22 ` [PATCH 2/6] SubmittingPatches: discuss non-ident trailers kristofferhaugsbakk
2026-06-12 11:35   ` Patrick Steinhardt
2026-06-16 20:02     ` Kristoffer Haugsbakk
2026-06-17  7:32       ` Patrick Steinhardt [this message]
2026-06-17 19:43         ` Kristoffer Haugsbakk
2026-06-10 22:22 ` [PATCH 3/6] SubmittingPatches: discourage common Linux trailers kristofferhaugsbakk
2026-06-11 16:46   ` Junio C Hamano
2026-06-10 22:22 ` [PATCH 4/6] SubmittingPatches: document Based-on-patch-by trailer kristofferhaugsbakk
2026-06-11 16:52   ` Junio C Hamano
2026-06-16 20:07     ` Kristoffer Haugsbakk
2026-06-10 22:22 ` [PATCH 5/6] SubmittingPatches: be consistent with trailer markup kristofferhaugsbakk
2026-06-10 22:22 ` [PATCH 6/6] SubmittingPatches: note that trailer order matters kristofferhaugsbakk
2026-06-10 22:30   ` Junio C Hamano
2026-06-16 20:18     ` Kristoffer Haugsbakk
2026-06-17 20:52 ` [PATCH v2 0/5] SubmittingPatches: update and flesh out trailer sections kristofferhaugsbakk
2026-06-17 20:52   ` [PATCH v2 1/5] SubmittingPatches: encourage trailer use for substantial help kristofferhaugsbakk
2026-06-17 21:41     ` Junio C Hamano
2026-06-17 20:52   ` [PATCH v2 2/5] SubmittingPatches: discourage common Linux trailers kristofferhaugsbakk
2026-06-17 20:52   ` [PATCH v2 3/5] SubmittingPatches: document Based-on-patch-by trailer kristofferhaugsbakk
2026-06-17 20:52   ` [PATCH v2 4/5] SubmittingPatches: be consistent with trailer markup kristofferhaugsbakk
2026-06-17 20:52   ` [PATCH v2 5/5] SubmittingPatches: note that trailer order matters kristofferhaugsbakk

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ajJNjOYMVDwL52zY@pks.im \
    --to=ps@pks.im \
    --cc=git@vger.kernel.org \
    --cc=kristofferhaugsbakk@fastmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox