From: Thorsten Leemhuis <linux@leemhuis.info>
To: Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org,
Linus Torvalds <torvalds@linux-foundation.org>
Cc: workflows@vger.kernel.org,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Randy Dunlap <rdunlap@infradead.org>,
regressions@lists.linux.dev,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: Re: [PATCH v4 1/3] docs: add two documents about regression handling
Date: Wed, 2 Feb 2022 11:05:38 +0100 [thread overview]
Message-ID: <35bf934c-d8ed-7988-69f3-e0cb53e0adf4@leemhuis.info> (raw)
In-Reply-To: <87k0ee5gf2.fsf@meer.lwn.net>
On 02.02.22 00:13, Jonathan Corbet wrote:
> OK, I'll try not to take so long to have a look at it this time.
>
> Thorsten Leemhuis <linux@leemhuis.info> writes:
>
>> Create two documents explaining various aspects around regression
>> handling and tracking; one is aimed at users, the other targets
>> developers.
>>
>> The texts among others describe the first rule of Linux kernel
>> development and what it means in practice. They also explain what a
>> regression actually is and how to report one properly.
>>
>> Both texts additionally provide a brief introduction to the bot the
>> kernel's regression tracker uses to facilitate the work, but mention the
>> use is optional.
>>
>> To sum things up, provide a few quotes from Linus in the document for
>> developers to show how serious he takes regressions.
>>
>> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
>> ---
>> Documentation/admin-guide/index.rst | 1 +
>> .../admin-guide/regressions-users.rst | 436 ++++++++++++
>> Documentation/process/index.rst | 1 +
>> Documentation/process/regressions-devs.rst | 672 ++++++++++++++++++
>
> I'll start with some *serious* bikesheddery...it's best if the names of
> the files tell readers what's inside. This isn't something I feel
> really strongly about, but we could consider
I wasn't totally happy with the file names myself, so it's good that you
bring it up.
> admin-guide/reporting-regressions.txt (or just regressions.txt)
> process/regression-policy.txt
I like "reporting-regressions.txt", but I wonder if using the word
"policy" is a good idea. I tried to avoid it (and similar words, like
guidelines), as they might do more harm then good. So how about:
admin-guide/reporting-regressions.rst
process/regressions.rst
> [...]
>> +Send a mail to the regressions mailing list (regressions@lists.linux.dev) while
>> +CCing the Linux kernel's regression tracker (regressions@leemhuis.info); if the
>> +issue might better be dealt with in private, feel free to omit the list.
>
> Perhaps a separate concern, but might you want to set up an @kernel.org
> alias for the regression tracker? Trust me, you're not gonna want to
> run it forever, and the ability to quickly redirect the mail may prove
> to be a nice thing to have. An email address with your domain sitting
> in the docs will circulate for years after it gets changed.
Yeah, it's on my mental to do list for a few weeks already, but never
set down to actually get this rolling. You are right, I'll ask for an alias.
>> +Is the "no regressions" rule really adhered in practice?
>> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>> +
>> +It's taken really serious, as can be seen by many mailing list posts from Linux
>
> serious*ly*
Fixed.
> Otherwise I can't find a lot to complain about at this point. I'm not
> really convinced that we need all those Quotations From Chairman Linus,
> but I won't fight about it either :)
I'll take a look again and consider kicking a few.
> In general, though, unless objections show up, I don't see any real
> reason to not apply this one.
Great, many thx!
Ciao, Thorsten
next prev parent reply other threads:[~2022-02-02 10:05 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-01 10:26 [PATCH v4 0/3] docs: add two texts covering regressions Thorsten Leemhuis
2022-02-01 10:26 ` [PATCH v4 1/3] docs: add two documents about regression handling Thorsten Leemhuis
2022-02-01 23:13 ` Jonathan Corbet
2022-02-02 10:05 ` Thorsten Leemhuis [this message]
2022-02-01 10:26 ` [PATCH v4 2/3] docs: regressions*rst: rules of thumb for handling regressions Thorsten Leemhuis
2022-02-01 23:21 ` Jonathan Corbet
2022-02-02 9:47 ` Thorsten Leemhuis
2022-02-01 10:26 ` [PATCH v4 3/3] docs: reporting-issues.rst: link new document about regressions Thorsten Leemhuis
2022-02-01 23:23 ` Jonathan Corbet
2022-02-02 6:08 ` 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=35bf934c-d8ed-7988-69f3-e0cb53e0adf4@leemhuis.info \
--to=linux@leemhuis.info \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=rdunlap@infradead.org \
--cc=regressions@lists.linux.dev \
--cc=torvalds@linux-foundation.org \
--cc=workflows@vger.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;
as well as URLs for NNTP newsgroup(s).