From: Jonathan Corbet <corbet@lwn.net>
To: Konstantin Ryabitsev <konstantin@linuxfoundation.org>,
Thorsten Leemhuis <linux@leemhuis.info>
Cc: Randy Dunlap <rdunlap@infradead.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 1/1] docs: submitting-patches: make section about the Link: tag more explicit
Date: Tue, 26 Oct 2021 09:49:24 -0600 [thread overview]
Message-ID: <87wnlzeqgr.fsf@meer.lwn.net> (raw)
In-Reply-To: <20211025210536.hlmkpjwf3nll6mlm@meerkat.local>
Konstantin Ryabitsev <konstantin@linuxfoundation.org> writes:
> On Mon, Oct 25, 2021 at 11:06:35AM +0200, Thorsten Leemhuis wrote:
>> +If related discussions or any other background information behind the change
>> +can be found on the web, add 'Link:' tags pointing to it. In case 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 is a result of some
>> +earlier mailing list discussion or something documented on the web, point to
>> +it.
>
> The "for example" is splitting the sentence awkwardly, so I would move it to
> the beginning of the sentence:
>
> "For example, in case your patch fixes a bug, add ..." etc
>
> Otherwise,
>
> Reviewed-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
I tweaked things along these lines and applied the patch, thanks.
jon
next prev parent reply other threads:[~2021-10-26 15:49 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-25 9:06 [PATCH v3 0/1] docs: improve when and how to use Link: tags Thorsten Leemhuis
2021-10-25 9:06 ` [PATCH v3 1/1] docs: submitting-patches: make section about the Link: tag more explicit Thorsten Leemhuis
2021-10-25 21:05 ` Konstantin Ryabitsev
2021-10-26 15:49 ` Jonathan Corbet [this message]
2021-10-26 16:45 ` Thorsten Leemhuis
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=87wnlzeqgr.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=konstantin@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@leemhuis.info \
--cc=rdunlap@infradead.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;
as well as URLs for NNTP newsgroup(s).