From: Matthias Brugger <mbrugger@suse.com>
To: Thorsten Leemhuis <linux@leemhuis.info>,
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>,
Jonathan Corbet <corbet@lwn.net>,
Randy Dunlap <rdunlap@infradead.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: Re: [RFC PATCH v2 1/2] docs: add a document about regression handling
Date: Fri, 7 Jan 2022 16:37:11 +0100 [thread overview]
Message-ID: <28b56512-d681-4a3a-98f0-a2eae34a217e@suse.com> (raw)
In-Reply-To: <f71246e0999520d681c7b35d24f7eed2f53ee2b4.1641565030.git.linux@leemhuis.info>
On 07/01/2022 15:21, Thorsten Leemhuis wrote:
> Create a document explaining various aspects around regression handling
> and tracking both for users and developers. Among others describe the
> first rule of Linux kernel development and what it means in practice.
> Also explain what a regression actually is and how to report one
> properly. The text additionally provides a brief introduction to the bot
> the kernel's regression tracker uses to facilitate his work. To sum
> things up, provide a few quotes from Linus to show how serious he takes
> regressions.
>
> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
> ---
> Documentation/admin-guide/index.rst | 1 +
> Documentation/admin-guide/regressions.rst | 886 ++++++++++++++++++++++
> MAINTAINERS | 1 +
> 3 files changed, 888 insertions(+)
> create mode 100644 Documentation/admin-guide/regressions.rst
>
> diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
> index 1bedab498104..17157ee5a416 100644
> --- a/Documentation/admin-guide/index.rst
> +++ b/Documentation/admin-guide/index.rst
> @@ -36,6 +36,7 @@ problems and bugs in particular.
>
> reporting-issues
> security-bugs
> + regressions
> bug-hunting
> bug-bisect
> tainted-kernels
> diff --git a/Documentation/admin-guide/regressions.rst b/Documentation/admin-guide/regressions.rst
> new file mode 100644
> index 000000000000..6eb8d9784a1f
> --- /dev/null
> +++ b/Documentation/admin-guide/regressions.rst
> @@ -0,0 +1,886 @@
> +.. SPDX-License-Identifier: (GPL-2.0+ OR CC-BY-4.0)
> +..
> + If you want to distribute this text under CC-BY-4.0 only, please use 'The
> + Linux kernel developers' for author attribution and link this as source:
> + https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/admin-guide/regressions.rst
> +..
> + Note: Only the content of this RST file as found in the Linux kernel sources
> + is available under CC-BY-4.0, as versions of this text that were processed
> + (for example by the kernel's build system) might contain content taken from
> + files which use a more restrictive license.
> +
> +
> +Regressions
> ++++++++++++
> +
> +The first rule of Linux kernel development: '*We don't cause regressions*'.
> +Linux founder and lead developer Linus Torvalds strictly enforces the rule
> +himself. This document describes what this means in practice and how the Linux
> +kernel's development model ensures all reported regressions are addressed; it
> +covers aspects relevant for both users and developers.
> +
> +The important bits for people affected by regressions
> +=====================================================
> +
> +It's a regression if something running fine with one Linux kernel works worse or
> +not at all with a newer version. Note, the newer kernel has to be compiled using
> +a similar configuration -- for this and other fine print, check out below
> +section "What is a 'regression' and what is the 'no regressions rule'?".
> +
> +Report your regression as outlined in
> +`Documentation/admin-guide/reporting-issues.rst`, it already covers all aspects
> +important for regressions. Below section "How do I report a regression?"
> +highlights them for convenience.
> +
> +The most important aspect: CC or forward the report to `the regression mailing
> +list <https://lore.kernel.org/regressions/>`_ (regressions@lists.linux.dev).
> +When doing so, consider mentioning the version range where the regression
> +started using a paragraph like this::
> +
> + #regzbot introduced v5.13..v5.14-rc1
> +
> +The Linux kernel regression tracking bot 'regzbot' will then add the report to
> +the list of tracked regressions. This is in your interest, as it brings the
> +report on the radar of people ensuring all regressions are acted upon in a
> +timely manner.
> +
> +The important bits for people fixing regressions
> +================================================
> +
> +When receiving regression reports by mail, check if the reporter CCed `the
> +regression mailing list <https://lore.kernel.org/regressions/>`_
> +(regressions@lists.linux.dev). If not, forward or bounce the report to the Linux
> +kernel's regression tracker (regressions@leemhuis.info), unless you plan on
I would have expected it to be the same mailing list
(regressions@lists.linux.dev), is this a typo maybe?
Regards,
Matthias
next prev parent reply other threads:[~2022-01-07 15:37 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-07 14:21 [RFC PATCH v2 0/2] docs: add a text about regressions to the Linux kernel's documentation Thorsten Leemhuis
2022-01-07 14:21 ` [RFC PATCH v2 1/2] docs: add a document about regression handling Thorsten Leemhuis
2022-01-07 15:37 ` Matthias Brugger [this message]
2022-01-07 16:51 ` Thorsten Leemhuis
2022-01-07 17:44 ` Matthias Brugger
2022-01-10 11:40 ` Thorsten Leemhuis
2022-01-10 12:13 ` Matthias Brugger (SUSE)
2022-01-07 14:21 ` [RFC PATCH v2 2/2] docs: regressions.rst: rules of thumb for handling regressions Thorsten Leemhuis
2022-01-07 16:28 ` [RFC PATCH v2 0/2] docs: add a text about regressions to the Linux kernel's documentation Greg Kroah-Hartman
2022-01-07 16:41 ` Thorsten Leemhuis
2022-01-07 16:42 ` 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=28b56512-d681-4a3a-98f0-a2eae34a217e@suse.com \
--to=mbrugger@suse.com \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@leemhuis.info \
--cc=lukas.bulwahn@gmail.com \
--cc=rdunlap@infradead.org \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.