Skip to content

Commit 127734e

Browse files
mriconJonathan Corbet
authored andcommitted
Documentation: best practices for using Link trailers
Based on multiple conversations, most recently on the ksummit mailing list [1], add some best practices for using the Link trailer, such as: - how to use markdown-like bracketed numbers in the commit message to indicate the corresponding link - when to use lore.kernel.org vs patch.msgid.link domains Cc: [email protected] Link: https://lore.kernel.org/20240617-arboreal-industrious-hedgehog-5b84ae@meerkat # [1] Signed-off-by: Konstantin Ryabitsev <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/20240619-docs-patch-msgid-link-v2-2-72dd272bfe37@linuxfoundation.org
1 parent 413e775 commit 127734e

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

Documentation/process/maintainer-tip.rst

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -372,17 +372,31 @@ following tag ordering scheme:
372372

373373
- Link: ``https://link/to/information``
374374

375-
For referring to an email on LKML or other kernel mailing lists,
376-
please use the lore.kernel.org redirector URL::
375+
For referring to an email posted to the kernel mailing lists, please
376+
use the lore.kernel.org redirector URL::
377377

378-
https://lore.kernel.org/r/email-message@id
378+
Link: https://lore.kernel.org/email-message-id@here
379379

380-
The kernel.org redirector is considered a stable URL, unlike other email
381-
archives.
380+
This URL should be used when referring to relevant mailing list
381+
topics, related patch sets, or other notable discussion threads.
382+
A convenient way to associate ``Link:`` trailers with the commit
383+
message is to use markdown-like bracketed notation, for example::
382384

383-
Maintainers will add a Link tag referencing the email of the patch
384-
submission when they apply a patch to the tip tree. This tag is useful
385-
for later reference and is also used for commit notifications.
385+
A similar approach was attempted before as part of a different
386+
effort [1], but the initial implementation caused too many
387+
regressions [2], so it was backed out and reimplemented.
388+
389+
Link: https://lore.kernel.org/some-msgid@here # [1]
390+
Link: https://bugzilla.example.org/bug/12345 # [2]
391+
392+
You can also use ``Link:`` trailers to indicate the origin of the
393+
patch when applying it to your git tree. In that case, please use the
394+
dedicated ``patch.msgid.link`` domain instead of ``lore.kernel.org``.
395+
This practice makes it possible for automated tooling to identify
396+
which link to use to retrieve the original patch submission. For
397+
example::
398+
399+
Link: https://patch.msgid.link/patch-source-message-id@here
386400

387401
Please do not use combined tags, e.g. ``Reported-and-tested-by``, as
388402
they just complicate automated extraction of tags.

0 commit comments

Comments
 (0)