public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: "Onur Özkan" <work@onurozkan.dev>
To: linux-kernel@vger.kernel.org
Cc: apw@canonical.com, joe@perches.com, dwaipayanray1@gmail.com,
	lukas.bulwahn@gmail.com, corbet@lwn.net,
	workflows@vger.kernel.org, linux-doc@vger.kernel.org,
	"Onur Özkan" <work@onurozkan.dev>
Subject: [PATCH v2 2/2] checkpatch: document new check PLACEHOLDER_USE
Date: Wed, 17 Sep 2025 20:37:25 +0300	[thread overview]
Message-ID: <20250917173725.22547-3-work@onurozkan.dev> (raw)
In-Reply-To: <20250917173725.22547-1-work@onurozkan.dev>

Adds documentation for the new check PLACEHOLDER_USE
in checkpatch.

Signed-off-by: Onur Özkan <work@onurozkan.dev>
---
 Documentation/dev-tools/checkpatch.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

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.
 
-- 
2.51.0


  parent reply	other threads:[~2025-09-17 17:37 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-17 17:37 [PATCH v2 0/2] checkpatch: add new check PLACEHOLDER_USE Onur Özkan
2025-09-17 17:37 ` [PATCH v2 1/2] checkpatch: detect unhandled placeholders in cover letters Onur Özkan
2025-09-17 17:37 ` Onur Özkan [this message]
2025-10-09 12:56 ` [PATCH v2 0/2] checkpatch: add new check PLACEHOLDER_USE Onur Özkan
2025-10-09 20:01 ` Joe Perches

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250917173725.22547-3-work@onurozkan.dev \
    --to=work@onurozkan.dev \
    --cc=apw@canonical.com \
    --cc=corbet@lwn.net \
    --cc=dwaipayanray1@gmail.com \
    --cc=joe@perches.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=workflows@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox