[RFC PATCH v2 04/10] docs: submitting-patches: Introduce Tested-with:

Nikolai Kondrashov
2023-12-05T18:45:49Z

Introduce a new tag, 'Tested-with:', documented in the
Documentation/process/submitting-patches.rst file.

The tag is expected to contain the test suite command which was executed
for the commit, and to certify it passed. Additionally, it can contain a
URL pointing to the execution results, after a '#' character.

Prohibit the V: field from containing the '#' character correspondingly.

Signed-off-by: Nikolai Kondrashov <Nikolai.Kondrashov@redhat.com>
---
Documentation/process/submitting-patches.rst | 10 ++++++++++
MAINTAINERS | 2 +-
scripts/checkpatch.pl | 4 ++--
3 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index f034feaf1369e..2004df2ac1b39 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -245,6 +245,16 @@ Execute the commands, if any, to test your changes.
All commands must be executed from the root of the source tree. Each command
outputs usage information, if an -h/--help option is specified.

+If a test suite you've executed completed successfully, add a ``Tested-with:
+<command>`` to the message of the commit you tested. E.g.::
+
+ Tested-with: tools/testing/kunit/run_checks.py
+
+Optionally, add a '#' character followed by a publicly-accessible URL
+containing the test results, if you make them available. E.g.::
+
+ Tested-with: tools/testing/kunit/run_checks.py # https://kernelci.org/test/2239874
+

Select the recipients for your patch
------------------------------------
diff --git a/MAINTAINERS b/MAINTAINERS
index 68821eecf61cf..28fbb0eb335ba 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -63,7 +63,7 @@ Descriptions of section entries and preferred order
executed to verify changes to the maintained subsystem.
Must be executed from the root of the source tree.
Must support the -h/--help option.
- Cannot contain '@' character.
+ Cannot contain '@' or '#' characters.
V: tools/testing/kunit/run_checks.py
One test suite per line.

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index a184e576c980b..bea602c30df5d 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3686,9 +3686,9 @@ sub process {
# check MAINTAINERS V: entries are valid
if ($rawline =~ /^\+V:\s*(.*)/) {
my $name = $1;
- if ($name =~ /@/) {
+ if ($name =~ /[@#]/) {
ERROR("TEST_PROPOSAL_INVALID",
- "Test proposal cannot contain '\@' character\n" . $herecurr);
+ "Test proposal cannot contain '\@' or '#' characters\n" . $herecurr);
}
}
}
--
2.42.0