From: Brendan Jackman <jackmanb@google.com>
To: Andy Whitcroft <apw@canonical.com>, Joe Perches <joe@perches.com>,
Dwaipayan Ray <dwaipayanray1@gmail.com>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Jonathan Corbet <corbet@lwn.net>
Cc: linux-kernel@vger.kernel.org, workflows@vger.kernel.org,
linux-doc@vger.kernel.org, Brendan Jackman <jackmanb@google.com>
Subject: [PATCH 2/2] docs: checkpatch: Document Checkpatch-ignore patch footer
Date: Mon, 13 Jan 2025 16:04:23 +0000 [thread overview]
Message-ID: <20250113-checkpatch-ignore-v1-2-63a7a740f568@google.com> (raw)
In-Reply-To: <20250113-checkpatch-ignore-v1-0-63a7a740f568@google.com>
If included in patch descriptions, this will function much like the
--ignore flag.
Checkpatch-ignore: EMAIL_SUBJECT
Signed-off-by: Brendan Jackman <jackmanb@google.com>
---
Documentation/dev-tools/checkpatch.rst | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index abb3ff6820766ee0c29112b256bcc44ce41fffba..b1d5616c72029d3d8c8c236cd8d05bb839018c0a 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -10,8 +10,12 @@ also be run on file contexts and without the kernel tree.
Checkpatch is not always right. Your judgement takes precedence over checkpatch
messages. If your code looks better with the violations, then its probably
-best left alone.
+best left alone. If you do that, consider adding the Checkpatch-ignore patch
+footer to record this decision.
+For example::
+
+ Checkpatch-ignore: EMAIL_SUBJECT,MACRO_ARG_REUSE
Options
=======
@@ -114,6 +118,9 @@ Available options:
Checkpatch will not emit messages for the specified types.
+ Note that violations can also be permanently disabled using the
+ Checkpatch-ignore patch footer.
+
Example::
./scripts/checkpatch.pl mypatch.patch --ignore EMAIL_SUBJECT,BRACES
--
2.47.1.613.gc27f4b7a9f-goog
next prev parent reply other threads:[~2025-01-13 16:04 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-13 16:04 [PATCH 0/2] checkpatch: Add support for " Brendan Jackman
2025-01-13 16:04 ` [PATCH 1/2] " Brendan Jackman
2025-01-13 19:15 ` Joe Perches
2025-01-14 11:42 ` Brendan Jackman
2025-01-14 11:43 ` Brendan Jackman
2025-01-14 13:34 ` Konstantin Ryabitsev
2025-01-14 14:25 ` Brendan Jackman
2025-01-14 16:04 ` Konstantin Ryabitsev
2025-01-14 18:29 ` Brendan Jackman
2025-01-14 19:26 ` Konstantin Ryabitsev
2025-01-15 9:58 ` Brendan Jackman
2025-01-13 16:04 ` Brendan Jackman [this message]
2025-01-13 16:20 ` [PATCH 0/2] " Matthew Wilcox
2025-01-13 17:11 ` Brendan Jackman
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=20250113-checkpatch-ignore-v1-2-63a7a740f568@google.com \
--to=jackmanb@google.com \
--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