Skip to contentSkip to conversation

Documentation: Add patch-validator to dev-tools

PATCH In review Ignacio Peña 2 participants 2 messages Jul 17, 2025

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: Add patch-validator to dev-tools

From: Ignacio Pena <[email protected]>

Add documentation for patch-validator, a comprehensive tool that helps kernel contributors validate their patches before submission. This tool catches common mistakes that frequently lead to patch rejections, improving the quality of submissions and reducing maintainer workload.

The validator performs 21+ automated checks including:
- Patch format validation (subject line, changelog placement)
- DCO compliance and licensing verification
- checkpatch.pl integration with enhanced reporting
- Build impact analysis and testing recommendations
- Common novice pattern detection
- Git configuration validation

Also includes companion tools for finding first contributions, testing patches safely, and validating patch series.

---
 Documentation/dev-tools/index.rst           |   1 +
 Documentation/dev-tools/patch-validator.rst | 287 +++++++++++++++++++
 2 files changed, 288 insertions(+)
 create mode 100644 Documentation/dev-tools/patch-validator.rst
Documentation/dev-tools/index.rst +1 -0
index 000000000000..111111111111 100644
@@ -32,6 +32,7 @@ Documentation/dev-tools/testing-overview.rst
    kunit/index
    ktap
    checkpatch
+   patch-validator
    coccinelle
    sparse
    kcov
Documentation/dev-tools/patch-validator.rst new file +287 -0

287 lines not on this page · raw message

Signature · 1 line
2.39.5
maintainer
#1 lore raw
Quoted 18 lines · Ignacio Peña

From: Ignacio Pena <[email protected]>

Add documentation for patch-validator, a comprehensive tool that helps kernel contributors validate their patches before submission. This tool catches common mistakes that frequently lead to patch rejections, improving the quality of submissions and reducing maintainer workload.

The validator performs 21+ automated checks including:
- Patch format validation (subject line, changelog placement)
- DCO compliance and licensing verification
- checkpatch.pl integration with enhanced reporting
- Build impact analysis and testing recommendations
- Common novice pattern detection
- Git configuration validation

Also includes companion tools for finding first contributions, testing patches safely, and validating patch series.

Quoted 7 lines
---
 Documentation/dev-tools/index.rst           |   1 +
 Documentation/dev-tools/patch-validator.rst | 287 +++++++++++++++++++
 2 files changed, 288 insertions(+)
 create mode 100644 Documentation/dev-tools/patch-validator.rst

Interesting ... overall, we don't generally have detailed documentation for out-of-tree utilities, though there isn't necessarily any reason why we couldn't. But I'm curious as to why you haven't submitted the tool itself?

Thanks,

jon