Commit 55b453ed authored by Onur Özkan's avatar Onur Özkan Committed by Andrew Morton
Browse files

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: default avatarOnur Özkan <work@onurozkan.dev>
Acked-by: default avatarJoe 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: default avatarAndrew Morton <akpm@linux-foundation.org>
parent fc387a07

Documentation/dev-tools/checkpatch.rst

+10 −0
Original line number Diff line number Diff line
@@ -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.