linux-kernel - Re: [RFC PATCH v2 1/2] docs: add a document about regression handling

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <28b56512-d681-4a3a-98f0-a2eae34a217e@suse.com>
Date:   Fri, 7 Jan 2022 16:37:11 +0100
From:   Matthias Brugger <mbrugger@...e.com>
To:     Thorsten Leemhuis <linux@...mhuis.info>, linux-doc@...r.kernel.org,
        Linus Torvalds <torvalds@...ux-foundation.org>
Cc:     workflows@...r.kernel.org,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Randy Dunlap <rdunlap@...radead.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: Re: [RFC PATCH v2 1/2] docs: add a document about regression handling



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@...mhuis.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@...ts.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@...ts.linux.dev). If not, forward or bounce the report to the Linux
> +kernel's regression tracker (regressions@...mhuis.info), unless you plan on

I would have expected it to be the same mailing list 
(regressions@...ts.linux.dev), is this a typo maybe?

Regards,
Matthias