Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Wed, 6 Oct 2021 13:00:25 -0400
From:   Konstantin Ryabitsev <konstantin@linuxfoundation.org>
To:     Thorsten Leemhuis <linux@leemhuis.info>
Cc:     Jonathan Corbet <corbet@lwn.net>,
        Randy Dunlap <rdunlap@infradead.org>,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v1] docs: submitting-patches: make section on linking
 more explicit
Message-ID: <20211006170025.qw3glxvocczfuhar@meerkat.local>
References: <7dff33afec555fed0bf033c910ca59f9f19f22f1.1633537634.git.linux@leemhuis.info>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
In-Reply-To: <7dff33afec555fed0bf033c910ca59f9f19f22f1.1633537634.git.linux@leemhuis.info>
Precedence: bulk

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.

-K