lkml.org 
[lkml]   [2021]   [Oct]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v1] docs: submitting-patches: make section on linking more explicit
On 06.10.21 19:00, Konstantin Ryabitsev wrote:
> On Wed, Oct 06, 2021 at 06:37:38PM +0200, Thorsten Leemhuis wrote:
>> +Add 'Link:' tags with URLs pointing to related discussions and rationale
>> +behind the change whenever that makes sense. If your patch for example
>> +fixes a bug, add a tag with a URL referencing the report in the mailing
>> +list archives or a bug tracker; if the patch follows from a mailing list
>> +discussion, point to it. When linking to mailing list archives, use the
>> +https://lkml.kernel.org/r/ redirector with a ``Message-Id``, to ensure
>
> We shouldn't be using "lkml.kernel.org" because that domain name can create
> confusion that this is only valid for messages sent to "the LKML"
> (linux-kernel@vger.kernel.org). The convention has been to use
> https://lore.kernel.org/r/msgid for this reason. I would also reword that a
> bit:
>
> ... or a bug tracker; if the patch was discussed on a mailing list, you
> may point to it using the lore.kernel.org message archiver service. To
> create the link URL, use the contents of the ``Message-Id`` header of the
> patch message without the surrounding angle brackets. For example::
>
> Link: https://lore.kernel.org/r/git-send-email.555-1234@example.org
>
> Please check the link to make sure that it is actually working and points
> to the relevant message.

Thx, feedback like this was exactly why I CCed you. So I'll do what I
outlined in my earlier mail already: prepare a patch that first does a
s!lkml.kernel.org!lore.kernel.org! in everywhere in Documentation/ where
it makes sense.

Ciao, Thorsten

\
 
 \ /
  Last update: 2021-10-06 19:23    [W:0.038 / U:0.344 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site