Received-SPF: pass (google.com: domain of linux-kernel+bounces-139341-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Jonathan Corbet <corbet@lwn.net>
To: Thorsten Leemhuis <linux@leemhuis.info>
Cc: regressions@lists.linux.dev, linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org, workflows@vger.kernel.org
Subject: Re: [RFC PATCH v1 2/2] docs: reporting-issue: rework the TLDR
In-Reply-To: <2f5a78745cbe0a99a4592612d6ffd57a17619fb4.1711455295.git.linux@leemhuis.info>
References: <cover.1711455295.git.linux@leemhuis.info>
 <2f5a78745cbe0a99a4592612d6ffd57a17619fb4.1711455295.git.linux@leemhuis.info>
Date: Wed, 10 Apr 2024 15:00:03 -0600
Message-ID: <878r1lszl8.fsf@meer.lwn.net>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

Thorsten Leemhuis <linux@leemhuis.info> writes:

> Rework the TLDR (aka the short guide) for various reasons:
>
> * People had to read it entirely and then act upon what they learned,
>   which from feedback I got was apparently somewhat hard and confusing
>   given everything we expect from bug reporters; this partly was because
>   the first paragraph covered a special case (regression in
>   stable/longterm kernel) and not the main aspect most people cared
>   about when they came to the document.
>
>   Use a step-by-step approach to avoid this.
>
> * Make use of
>   Documentation/admin-guide/verify-bugs-and-bisect-regressions.rst
>
> * The 'quickly report a stable regression to the stable team' approach
>   hardly worked out: most of the time the regression was not known yet.
>   Try a different approach using the regressions list.
>
> * Reports about stable/longterm regressions most of the time were
>   greeted with a brief reply along the lines of 'Is mainline affected as
>   well?'; this is needed to determine who is responsible, so it might as
>   well make the reporter check that before sending the report (which
>   verify-bugs-and-bisect-regressions.rst already tells them to do, too).
>
> Not-signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
> ---
>  .../admin-guide/reporting-issues.rst          | 104 +++++++++++-------
>  1 file changed, 62 insertions(+), 42 deletions(-)

From a quick read, no objections here.

jon