Message-ID: <28b56512-d681-4a3a-98f0-a2eae34a217e@suse.com>
Date:   Fri, 7 Jan 2022 16:37:11 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.2.0
Content-Language: en-US
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>
References: <cover.1641565030.git.linux@leemhuis.info>
 <f71246e0999520d681c7b35d24f7eed2f53ee2b4.1641565030.git.linux@leemhuis.info>
From:   Matthias Brugger <mbrugger@suse.com>
Subject: Re: [RFC PATCH v2 1/2] docs: add a document about regression handling
In-Reply-To: <f71246e0999520d681c7b35d24f7eed2f53ee2b4.1641565030.git.linux@leemhuis.info>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?UmF4bXVsc0hCS2l1bytFblpjUkxsVUhPT09aR1RqbjV4cVJEMFk3TTlJbXBB?=
 =?utf-8?B?d3hEVmNSWk9qT1BxZElYU3JqQXlyNWtiQzB6WTVOWHBIZTNoUkRUQVJHTUZh?=
 =?utf-8?B?VFZpSFg1VUF0cmtWb3laMmlXeFRwc2JhQjdzZHdjVjAraXAzZXR4MmgybUNn?=
 =?utf-8?B?NU92S2REZ3VyeWZPSUExbTBwcExhVUt6b3N1cklFanRUbGZUK1I2SnpQeFZC?=
 =?utf-8?B?MjQ1S1I5bnNhazd1cmhKdC9DZmJ0d0NINDJtcTNNR1B0RWVVd2RzN0VwYXNF?=
 =?utf-8?B?eHpORE5FVGt1bmJnZWVzNWRZMk8wVmNVaDdwUVBWblhLaHY2UVJKY29ZK0U0?=
 =?utf-8?B?ZTJrZUF2Y3Btd3Jwak95SkJFbXE3TVVJZHpzWEVwOXlRQWluRnZzZTVES1Fh?=
 =?utf-8?B?ekZITkRnR1gvRkpYV2g2TXNVUEErWm1INXNjU0RWbVUreFZRZ1puUWlBTktO?=
 =?utf-8?B?cDB6L0FLQXEwaU5PMTFqUklPbDFNa0FrN0RDMnF0K3N3bi8rcGxaQzUwMDd5?=
 =?utf-8?B?citJUXdYSDF6anN6Mk5UVVVyajVOTHp0QWlSVTlmanp4aG12eFhOdUpiakQz?=
 =?utf-8?B?VXNzWEtrU0QvRlE5Z0lhdG9jdVNpaXd3azllNlpRNmhxTHJudUVlM2RMeHBr?=
 =?utf-8?B?aTg3T083T1RyRzRBVE1LMGltMjVCM01sUUxCcVBzT3ZhVHpobTRmTngvazJv?=
 =?utf-8?B?a0hKelJ5OE1WL3ByVit2NHJvUlZyTFhBT1RCWUdVZkM4aHRoMXpXaE9semZ1?=
 =?utf-8?B?SDRIUlp6ck1TdVRhSTRYZXFJbVEzczVGb1pVWEFuL1NabXVDTjhQWWRUZGx2?=
 =?utf-8?B?NnVVWjRKZHpNM2xrOHBGZTZZM2tGcEM1Y3pMUDZnckdvU2YzQmRpVEpHcGZV?=
 =?utf-8?B?V3Y4cXZrdURoamNIZHVFVEgxZUFjMXhta3o0MVduZDBFVm5ZUHcxRDZtdjlu?=
 =?utf-8?B?QTZubjF4RlozVmRiSlRnQmJnODZsUWVvanFqOUJCUG91aHJ5Uk1mQ2NrVWh1?=
 =?utf-8?B?VGJJQkYxMmRsbU1tb3Z0SllqWnBEV2pKYWVtOEwwZU1CL1NuQjlxaEVOOTJm?=
 =?utf-8?B?SDZrNmFTdFBNVE9XRXcxSHJIT3VtV29STVFCelV1MWlxTFFlajZKNlFkVWtU?=
 =?utf-8?B?cmFQUmR0WkpMbUgrSzhzUGtsNUc0Z2R0RnRDSmZCYVZsUm9ITXREWkJrWktO?=
 =?utf-8?B?V0tVNU1YQWEvOHF0RGgrWGNONldPS1VxY2VRNmZtTmNkMWZzQ291Zzc4NEtC?=
 =?utf-8?B?NENhbHFxWDZ6SC9TaDZlZG5BdVIzUURFT1NYMTAwb2lTbzZQTWhNMnB6UThr?=
 =?utf-8?B?cHp0VWV6ZzdLcXEyMDJpVTNISmsrSEpXWGVxWTI1Rzk5bUlDR1pEQ2ZMREpR?=
 =?utf-8?B?U3pHMVlIdUlvVDEwalJQNDNGYyt6QmkvbTRKajViTFp5K2hnNjdSbWxxcG1h?=
 =?utf-8?B?SW1YbWFOQ2drQTIwaTE3Q2hVdUhoeHRtNm11ZG9uU20xSSthQXJyU3dqdmZL?=
 =?utf-8?B?cTJjWmxtTmtMbHJiRzdKbm9DZG9WK1ZLNjZwK2FzSHk0Q1FhNkUyK1U3Yll0?=
 =?utf-8?B?YWhQZ3M3S3htdVZWUFN3cE9hWkFBTUlhMXJwQVlFV0FWM1JsYThZaC9XdmdU?=
 =?utf-8?B?cmJubXFMMG1rakZscWNydVVlRWZvRXdSWjZPODh2VS9Va1pPWldoS2hmVVFj?=
 =?utf-8?B?d1lTTU1NY05TS281Y25MMkN2aDlsRWs2ZGprVVlVTE5leFV4V0MvTFUvT3dE?=
 =?utf-8?B?WXlibGUvY24yMGxIQTlqZmpLZHFoYnVIejRERmx6d3hPZHY3eERuUjdrazdo?=
 =?utf-8?B?ckg1bVJTbWpOeXFyZWhiNmVpaWlTaEI3S2h3aS9XYVdkeWRjd2YyVTExajFH?=
 =?utf-8?B?YVgvMFZwR1orNkpuYldTWHNSZGxXYnUzK3NCTjVsSC85OVJTY29aWXhtV0pC?=
 =?utf-8?B?c1lYaVh6U3RrU0FGaVp2VHdkK0N1WjAxRmhuRWlNdnhJT1hYdGVjNytJR3Nw?=
 =?utf-8?B?dXd4eW9OYXlabkxmK3lNbzRmUkFhRnZoa3l2cmVvY2l1QlFYRm9BK1Vxd0NI?=
 =?utf-8?B?WlNNRldDUUkvRzlYMlA1M29ZVjR0RS9jSy9wSjFFeGZ0Mm8rSVVTd3F0aUV0?=
 =?utf-8?B?ZVFLbmtET3kwcURCeXRHeU93NUZpWGF6bXprOThJR0JUTjhJZU1CN01pbytQ?=
 =?utf-8?Q?43K6vkzpTo9RZ4YvLY7JkxQ=3D?=
X-OriginatorOrg: suse.com
X-MS-Exchange-CrossTenant-Network-Message-Id: d3969731-4a5c-42ad-0e33-08d9d1f393a3
X-MS-Exchange-CrossTenant-AuthSource: AM6PR04MB5366.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Jan 2022 15:37:13.6049
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: f7a17af6-1c5c-4a36-aa8b-f5be247aa4ba
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: m9Lpua22hTq8lUC4VD4vtdW+vyiPjCKSrRdCLUaAgm7loMFbwM0qy0TuBYODiAx7nDEfwzQPVNHQ82e2UPLlXQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM6PR0402MB3317
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org


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