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
Date: Wed, 10 Apr 2024 15:00:03 -0600 [thread overview]
Message-ID: <878r1lszl8.fsf@meer.lwn.net> (raw)
In-Reply-To: <2f5a78745cbe0a99a4592612d6ffd57a17619fb4.1711455295.git.linux@leemhuis.info>
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
prev parent reply other threads:[~2024-04-10 21:00 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-26 12:21 [RFC PATCH v1 0/2] docs: reporting-issues: rework while involving the 'verify bugs' text Thorsten Leemhuis
2024-03-26 12:21 ` [RFC PATCH v1 1/2] docs: reporting-issue: rework the detailed guide Thorsten Leemhuis
2024-04-10 20:58 ` Jonathan Corbet
2024-03-26 12:21 ` [RFC PATCH v1 2/2] docs: reporting-issue: rework the TLDR Thorsten Leemhuis
2024-04-10 21:00 ` Jonathan Corbet [this message]
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=878r1lszl8.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@leemhuis.info \
--cc=regressions@lists.linux.dev \
--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.