Netdev List
 help / color / mirror / Atom feed
* [PATCH net-next] docs: netdev: additional info requirements for bug fixes
@ 2026-09-28 18:49 Jakub Kicinski
  2026-09-30  6:57 ` Nicolai Buchwitz
  0 siblings, 1 reply; 2+ messages in thread
From: Jakub Kicinski @ 2026-09-28 18:49 UTC (permalink / raw)
  To: davem; +Cc: netdev, edumazet, pabeni, andrew+netdev, horms, Jakub Kicinski

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
 ~~~~~~~~~~~
 
-- 
2.55.0


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH net-next] docs: netdev: additional info requirements for bug fixes
  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
  0 siblings, 0 replies; 2+ messages in thread
From: Nicolai Buchwitz @ 2026-09-30  6:57 UTC (permalink / raw)
  To: Jakub Kicinski; +Cc: davem, netdev, edumazet, pabeni, andrew+netdev, horms

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-09-30  6:58 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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 is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox