summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOnur Özkan <work@onurozkan.dev>2025-09-17 20:37:25 +0300
committerAndrew Morton <akpm@linux-foundation.org>2025-11-12 03:48:29 +0300
commit55b453ed53d28da0b8d2316741e11eb22ceb39d6 (patch)
tree192c52a71eb145452919f5e536fb1b18ea8508e8
parentfc387a0704cc86cf47de0e64236577af3e148ec2 (diff)
downloadlinux-55b453ed53d28da0b8d2316741e11eb22ceb39d6.tar.xz
checkpatch: document new check PLACEHOLDER_USE
Adds documentation for the new check PLACEHOLDER_USE in checkpatch. Link: https://lkml.kernel.org/r/20250917173725.22547-3-work@onurozkan.dev Signed-off-by: Onur Özkan <work@onurozkan.dev> Acked-by: Joe Perches <joe@perches.com> Cc: Andy Whitcroft <apw@canonical.com> Cc: Dwaipayan Ray <dwaipayanray1@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Lukas Bulwahn <lukas.bulwahn@gmail.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
-rw-r--r--Documentation/dev-tools/checkpatch.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index d5c47e560324..4dccd1036870 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -1245,6 +1245,16 @@ Others
The patch file does not appear to be in unified-diff format. Please
regenerate the patch file before sending it to the maintainer.
+ **PLACEHOLDER_USE**
+ Detects unhandled placeholder text left in cover letters or commit headers/logs.
+ Common placeholders include lines like::
+
+ *** SUBJECT HERE ***
+ *** BLURB HERE ***
+
+ These typically come from autogenerated templates. Replace them with a proper
+ subject and description before sending.
+
**PRINTF_0XDECIMAL**
Prefixing 0x with decimal output is defective and should be corrected.