From: Borislav Petkov <bp@kernel.org>
To: X86 ML <x86@kernel.org>
Cc: LKML <linux-kernel@vger.kernel.org>,
"Borislav Petkov (AMD)" <bp@alien8.de>
Subject: [PATCH] Documentation/maintainer-tip: Update Link tag rules
Date: Tue, 9 Sep 2025 15:51:19 +0200 [thread overview]
Message-ID: <20250909135119.10420-1-bp@kernel.org> (raw)
From: "Borislav Petkov (AMD)" <bp@alien8.de>
Remove the rule about Link tag pointing to the upstream submission of
a patch as this is "frowned upon" now. Clarify when a Link tag should be
used.
Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de>
---
Documentation/process/maintainer-tip.rst | 20 +++++++++-----------
1 file changed, 9 insertions(+), 11 deletions(-)
diff --git a/Documentation/process/maintainer-tip.rst b/Documentation/process/maintainer-tip.rst
index 41d5855700cd..9dd700948261 100644
--- a/Documentation/process/maintainer-tip.rst
+++ b/Documentation/process/maintainer-tip.rst
@@ -377,11 +377,18 @@ following tag ordering scheme:
Link: https://lore.kernel.org/email-message-id@here
- This URL should be used when referring to relevant mailing list
- topics, related patch sets, or other notable discussion threads.
+ This URL should be used when referring to relevant mailing list topics,
+ related patch sets, or other notable discussion threads. Do not add a Link
+ tag to simply point to the mail which became the upstream commit - the Link
+ should contain interesting and otherwise relevant information regardling
+ the evolution of the change or any related side-discussion. See
+ https://lore.kernel.org/r/CAHk-=wh5AyuvEhNY9a57v-vwyr7EkPVRUKMPwj92yF_K0dJHVg@mail.gmail.com
+ for more info.
+
A convenient way to associate ``Link:`` trailers with the commit
message is to use markdown-like bracketed notation, for example::
+
A similar approach was attempted before as part of a different
effort [1], but the initial implementation caused too many
regressions [2], so it was backed out and reimplemented.
@@ -389,15 +396,6 @@ following tag ordering scheme:
Link: https://lore.kernel.org/some-msgid@here # [1]
Link: https://bugzilla.example.org/bug/12345 # [2]
- You can also use ``Link:`` trailers to indicate the origin of the
- patch when applying it to your git tree. In that case, please use the
- dedicated ``patch.msgid.link`` domain instead of ``lore.kernel.org``.
- This practice makes it possible for automated tooling to identify
- which link to use to retrieve the original patch submission. For
- example::
-
- Link: https://patch.msgid.link/patch-source-message-id@here
-
Please do not use combined tags, e.g. ``Reported-and-tested-by``, as
they just complicate automated extraction of tags.
--
2.51.0
next reply other threads:[~2025-09-09 13:51 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-09 13:51 Borislav Petkov [this message]
2025-09-11 4:56 ` [PATCH] Documentation/maintainer-tip: Update Link tag rules Huang, Kai
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=20250909135119.10420-1-bp@kernel.org \
--to=bp@kernel.org \
--cc=bp@alien8.de \
--cc=linux-kernel@vger.kernel.org \
--cc=x86@kernel.org \
/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