Linux Documentation
 help / color / mirror / Atom feed
From: Andrew Morton <akpm@linux-foundation.org>
To: Sasha Levin <sashal@kernel.org>
Cc: Willy Tarreau <w@1wt.eu>, Jonathan Corbet <corbet@lwn.net>,
	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] docs: submitting-patches: ask bug fixes for their user-visible impact
Date: Mon, 16 Nov 2026 11:58:59 -0800	[thread overview]
Message-ID: <20261116115859.0e89464677cf765681cf35d7@linux-foundation.org> (raw)
In-Reply-To: <20261116195205.335116-1-sashal@kernel.org>

On Mon, 16 Nov 2026 14:52:05 -0500 Sasha Levin <sashal@kernel.org> wrote:

> 
> Willy pointed out the other side of this: ask an LLM for the worst case
> and it'll stack up every config option, module and USB emulator needed
> to get there, while for backports you also want to know whether
> innocent users are affected at all.
> 
> I think both fit if we ask about the two cases separately. Something
> like this on top?
> 
> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
> --- a/Documentation/process/submitting-patches.rst
> +++ b/Documentation/process/submitting-patches.rst
> @@ -63,14 +63,26 @@ from upstream, so include anything that could help route your change
>  downstream: provoking circumstances, excerpts from dmesg, crash
>  descriptions, performance regressions, latency spikes, lockups, etc.
>  
> -For a bug fix, this means saying what the bug does to a running system:
> -the worst that a user can see, and what it takes to trigger it.  An
> -account of what the code does wrong is not a substitute, as it leaves
> -every reader to work the consequences out again.  If the bug was found
> -by review or by a tool and has never been seen to happen, say so.  If
> -it has no effect that a user could notice, say that too.  Maintainers
> -and the people looking after stable trees decide from this whether the
> -fix needs to be backported.
> +For a bug fix, this means saying what the bug does to a running system.
> +An account of what the code does wrong is not a substitute, as it leaves
> +every reader to work the consequences out again.  Cover two cases:
> +
> +- Users who are not looking for the bug.  Say what a normal workload is
> +  likely to run into, and separately what the worst case is and what it
> +  takes to get there: configuration, hardware, privileges, timing.  If
> +  the bug was found by review or by a tool and has never been seen to
> +  happen, say so.  If it has no effect that a user could notice, say
> +  that too.
> +
> +- Someone triggering the bug on purpose.  Say whether an unprivileged
> +  user could do it and what that would take.  A race that no normal
> +  workload loses can still be won by a program that retries it on every
> +  CPU for an hour.  If that makes the bug a vulnerability under
> +  Documentation/process/threat-model.rst, follow
> +  Documentation/process/security-bugs.rst.
> +
> +Maintainers and the people looking after stable trees decide from this
> +whether the fix needs to be backported.
>  
>  Quantify optimizations and trade-offs.  If you claim improvements in
>  performance, memory consumption, stack footprint, or binary size,
> 
> If that works for both of you I'll fold it into a v2.

Looks good, thanks.  Still
Acked-by: Andrew Morton <akpm@linux-foundation.org>

Of course we don't have to get this perfect.  Close enough is good
enough.  Deploy it, observe effects, fine-tune later.

  reply	other threads:[~2026-11-16 19:59 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-16 19:14 [PATCH] docs: submitting-patches: ask bug fixes for their user-visible impact Sasha Levin
2026-11-16 19:34 ` Andrew Morton
2026-11-16 19:49   ` Willy Tarreau
2026-11-16 19:52   ` Sasha Levin
2026-11-16 19:58     ` Andrew Morton [this message]
2026-11-16 20:01       ` Willy Tarreau
2026-11-16 19:47 ` Willy Tarreau

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=20261116115859.0e89464677cf765681cf35d7@linux-foundation.org \
    --to=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=david@kernel.org \
    --cc=gregkh@linuxfoundation.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