Netdev List
 help / color / mirror / Atom feed
From: Nicolai Buchwitz <nb@tipi-net.de>
To: Jakub Kicinski <kuba@kernel.org>
Cc: davem@davemloft.net, netdev@vger.kernel.org, edumazet@google.com,
	pabeni@redhat.com, andrew+netdev@lunn.ch, horms@kernel.org
Subject: Re: [PATCH net-next] docs: netdev: additional info requirements for bug fixes
Date: Wed, 30 Sep 2026 08:57:49 +0200	[thread overview]
Message-ID: <a4dcd1e19fd79772281974defbd3fb97@tipi-net.de> (raw)
In-Reply-To: <20260928184904.2496960-1-kuba@kernel.org>

On 28.9.2026 20:49, Jakub Kicinski wrote:
> Knowing how AI generated patches were tested would be a great help
> when reviewing them. Explicitly ask people to describe the discovery
> and validation process they followed.
> 
> I posted this as an RFC a while back and there were some concerns
> from developers that it will gum up the process. With Linus's
> recent complaints about the size of our PRs, we really need
> this information. I launched an AI bot which complains if
> people don't explain how bugs were discovered and tested
> (look for netdev-bot+sinfo@kernel.org, s=series info).
> We need to document this requirement.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
> rfc: https://lore.kernel.org/20260727204724.2787038-1-kuba@kernel.org
> ---
>  Documentation/process/maintainer-netdev.rst | 31 +++++++++++++++++++++
>  1 file changed, 31 insertions(+)
> 
> diff --git a/Documentation/process/maintainer-netdev.rst 
> b/Documentation/process/maintainer-netdev.rst
> index 1739d9f856c3..d46011a9b4b6 100644
> --- a/Documentation/process/maintainer-netdev.rst
> +++ b/Documentation/process/maintainer-netdev.rst
> @@ -283,6 +283,37 @@ as a patch to the list with a commit message 
> explaining the technical
>  problems with the reverted commit. Reverts should be used as a last 
> resort,
>  when original change is completely wrong; incremental fixes are 
> preferred.
> 
> +Bug fixes
> +~~~~~~~~~
> +
> +All bug fixes must state how the issue was discovered and validated,
> +and how the fix was tested. This should be done in plain English, not 
> with
> +special tags or annotations. That said, the information does not have 
> to be
> +provided if the existing trailers imply it (e.g. ``Reported-by: 
> syzbot...``
> +implies the discovery method and validation).
> +
> +Example statements describing discovery:
> +
> + - discovered by a non-AI static analysis tool
> + - discovered by an AI code review agent
> + - discovered by manual code inspection
> + - triggered during code development
> + - triggered in CI testing
> + - observed on a machine in real use
> +
> +If the discovery does not imply the issue was triggered, the next 
> sentence
> +should describe the reproduction. The commit message must disclose if 
> kernel
> +modifications (e.g. inserting a delay to widen the race, a loadable 
> module
> +with the right sequence of calls) or error injection were necessary 
> for
> +reproduction. The reproduction steps should be included in the commit
> +message if they are short (roughly 10 lines or fewer);
> +longer reproducers can be posted online with a link included.
> +
> +The testing statement should explain whether the fix was tested 
> against the
> +reproducer and against kernel selftests. If the bug is in a hardware 
> driver,
> +the testing statement must include information about the HW on which 
> the
> +fix was tested.
> +
>  Stable tree
>  ~~~~~~~~~~~

Reviewed-by: Nicolai Buchwitz <nb@tipi-net.de>

Thanks,
Nicolai

      reply	other threads:[~2026-09-30  6:58 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-28 18:49 [PATCH net-next] docs: netdev: additional info requirements for bug fixes Jakub Kicinski
2026-09-30  6:57 ` Nicolai Buchwitz [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=a4dcd1e19fd79772281974defbd3fb97@tipi-net.de \
    --to=nb@tipi-net.de \
    --cc=andrew+netdev@lunn.ch \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=horms@kernel.org \
    --cc=kuba@kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    /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