Linux Documentation
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzk@kernel.org>
To: Leon Romanovsky <leon@kernel.org>, Sasha Levin <sashal@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Andrew Morton <akpm@linux-foundation.org>,
	Willy Tarreau <w@1wt.eu>, Shuah Khan <skhan@linuxfoundation.org>,
	Randy Dunlap <rdunlap@infradead.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Theodore Ts'o <tytso@mit.edu>,
	David Hildenbrand <david@kernel.org>,
	workflows@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] docs: submitting-patches: ask bug fixes for their user-visible impact
Date: Thu, 19 Nov 2026 11:13:57 +0100	[thread overview]
Message-ID: <220c5818-ad59-4003-9955-9821d09c0279@kernel.org> (raw)
In-Reply-To: <20261117092723.GA124972@unreal>

On 17/11/2026 10:27, Leon Romanovsky wrote:
> On Mon, Nov 16, 2026 at 03:05:15PM -0500, Sasha Levin wrote:
>> "Describe your changes" already asks for the user-visible impact of a
>> change, but changelogs for fixes still tend to say what the code does,
>> why that's wrong and what the patch changes, and stop there. Whoever
>> has to decide if the fix needs backporting is left to work out what
>> the bug does to a running system.
>>
>> Say what that means for a bug fix, in two parts. For users who aren't
>> looking for the bug: what a normal workload is likely to run into, and
>> separately the worst case and what it takes to get there. For someone
>> triggering it on purpose: whether an unprivileged user could do it and
>> what that would take, since a race that no real workload loses can
>> still be won by a program written to win it. Give the paragraph a
>> label so people can be pointed at it.
>>
>> Coding assistants are told to commit a fix with a message that
>> describes the problem and the solution. Add the user-visible impact to
>> that list and point them at the section.
>>
>> Suggested-by: Andrew Morton <akpm@linux-foundation.org>
>> Link: https://lore.kernel.org/r/20261111171055.527b4bf3da705367bc78a64c@linux-foundation.org
>> Signed-off-by: Sasha Levin <sashal@kernel.org>
>> Acked-by: Andrew Morton <akpm@linux-foundation.org>
>> Reviewed-by: Willy Tarreau <w@1wt.eu>
>> ---
>> Changes since v1:
>> - Split the bug-fix paragraph into users who aren't looking for the bug
>>   and someone triggering it on purpose (Andrew, Willy).
>>
>> v1: https://lore.kernel.org/r/20261116191436.188098-1-sashal@kernel.org
>>
>>  Documentation/process/coding-assistants.rst  |  6 +++--
>>  Documentation/process/submitting-patches.rst | 23 ++++++++++++++++++++
>>  2 files changed, 27 insertions(+), 2 deletions(-)
> 
> Sasha,
> 
> Since you're already making changes in that area, could you add a sentence
> asking reporters to provide the full dmesg stack trace?

If so, then trimmed. We do not need all addresses and registers and the
[time markers], but rather the calltrace from decode_stacktrace.sh.
That's often review feedback, btw, people just paste huge bunch of dmesg
without thinking what is useful there.

Best regards,
Krzysztof

  parent reply	other threads:[~2026-11-19 10:14 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-16 20:05 [PATCH v2] docs: submitting-patches: ask bug fixes for their user-visible impact Sasha Levin
2026-11-17  9:00 ` Greg Kroah-Hartman
2026-11-17  9:27 ` Leon Romanovsky
2026-11-17 15:07   ` Sasha Levin
2026-11-17 15:27     ` Leon Romanovsky
2026-11-17 16:03       ` Sasha Levin
2026-11-19 10:13   ` Krzysztof Kozlowski [this message]
2026-11-19 10:29     ` Geert Uytterhoeven
2026-11-19 11:19       ` Leon Romanovsky
2026-11-19 11:19     ` Leon Romanovsky
2026-11-19 10:12 ` Krzysztof Kozlowski

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=220c5818-ad59-4003-9955-9821d09c0279@kernel.org \
    --to=krzk@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=david@kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=leon@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=sashal@kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=tytso@mit.edu \
    --cc=w@1wt.eu \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox