diff --git a/Documentation/process/maintainer-netdev.rst b/Documentation/process/maintainer-netdev.rst index 1739d9f856c3..df220a965438 100644 --- a/Documentation/process/maintainer-netdev.rst +++ b/Documentation/process/maintainer-netdev.rst @@ -283,6 +283,38 @@ 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 method does not imply the issue was triggered, the commit +message should describe the validation, i.e. how the bug was confirmed +to be real. The commit message must disclose whether reproducing the issue +required modifying the kernel (e.g. inserting a delay to widen a race, or +writing a loadable module to issue the right sequence of calls) or using error +injection. 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 ~~~~~~~~~~~