mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jason Hall <jason.kei.hall@gmail.com>
To: Joe Perches <joe@perches.com>, Miguel Ojeda <ojeda@kernel.org>
Cc: "Dirk Behme" <dirk.behme@gmail.com>,
	"Gary Guo" <gary@garyguo.net>, "Onur Özkan" <work@onurozkan.dev>,
	rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
	"Jason Hall" <jason.kei.hall@gmail.com>
Subject: [PATCH v5] scripts: checkpatch: move Rust-specific lints to separate file
Date: Wed,  4 Feb 2026 18:42:18 -0700	[thread overview]
Message-ID: <20260205014218.2202385-1-jason.kei.hall@gmail.com> (raw)
In-Reply-To: <a798e6a368639f7a1ce633a6dfecd088d6ed4123.camel@perches.com>

Move Rust linting logic into scripts/rust_checkpatch.pl to prevent
further growth of the main checkpatch.pl script.

Warn against the use of .unwrap() and .expect() unless accompanied by
a '// PANIC:' comment. This enforces safety standards in the Rust-
for-Linux project until upstream Clippy lints are integrated.

Suggested-by: Joe Perches <joe@perches.com>
Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-linux/linux/issues/1191
Signed-off-by: Jason Hall <jason.kei.hall@gmail.com>

---
v5:
 - Move Rust-specific logic to scripts/rust_checkpatch.pl (Suggested by Joe Perches).
 - Add conditional loading hook in scripts/checkpatch.pl.
 - Updated regex to use house-style comments.
v4:
 - Use imperative mood in commit description.
 - Fix patch formatting and placement of '---' separator.
v3:
 - Use non-capturing groups (?:) to optimize regex.
v2:
 - Switch from \b to (\.|::) to avoid false positives in strings.
 - Add : to PANIC comment check.
---
 scripts/checkpatch.pl      | 14 ++++++++++++++
 scripts/rust_checkpatch.pl | 25 +++++++++++++++++++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 scripts/rust_checkpatch.pl

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index c0250244cf7a..f75cb70ad0dd 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -20,6 +20,12 @@ my $D = dirname(abs_path($P));
 
 my $V = '0.32';
 
+my $rust_checkpatch_available = 0;
+if (-e "$D/rust_checkpatch.pl") {
+	require "$D/rust_checkpatch.pl";
+	$rust_checkpatch_available = 1;
+}
+
 use Getopt::Long qw(:config no_auto_abbrev);
 
 my $quiet = 0;
@@ -2947,6 +2953,14 @@ sub process {
 
 		$cnt_lines++ if ($realcnt != 0);
 
+# Check for Rust-specific lints
+		if ($rust_checkpatch_available && $realfile =~ /\.rs$/) {
+			my ($type, $msg) = process_rust($line, $rawline, $herecurr);
+			if ($type) {
+				WARN($type, $msg);
+			}
+		}
+
 # Verify the existence of a commit log if appropriate
 # 2 is used because a $signature is counted in $commit_log_lines
 		if ($in_commit_log) {
diff --git a/scripts/rust_checkpatch.pl b/scripts/rust_checkpatch.pl
new file mode 100644
index 000000000000..69db5ded7371
--- /dev/null
+++ b/scripts/rust_checkpatch.pl
@@ -0,0 +1,25 @@
+#!/usr/bin/env perl
+# SPDX-License-Identifier: GPL-2.0
+#
+# (c) 2026, Jason K. Hall <jason.kei.hall@gmail.com>
+
+use strict;
+use warnings;
+
+sub process_rust {
+    my ($line, $rawline, $herecurr) = @_;
+
+    # check for Rust unwrap/expect
+    if ($line =~ /^\+/) {
+        if ($line =~ /(?:\.|::)(?:unwrap|expect)\s*\(/ &&
+            $rawline !~ /\/\/\s*PANIC:/ &&
+            $line !~ /^\+\s*\/\// &&
+            $line !~ /^\+\s*assert/) {
+            return ("RUST_UNWRAP",
+                    "Avoid unwrap() or expect() in Rust code; use proper error handling (Result) or justify with a '// PANIC: ...' comment.\n" . $herecurr);
+        }
+    }
+    return ();
+}
+
+1;
\ No newline at end of file
-- 
2.43.0


  reply	other threads:[~2026-02-05  1:42 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-01 15:57 [PATCH] scripts: checkpatch: warn on Rust panicking methods Jason Hall
2026-02-01 17:19 ` Charalampos Mitrodimas
2026-02-01 18:30   ` [PATCH v2] " Jason Hall
2026-02-01 19:37     ` Joe Perches
2026-02-01 19:57   ` [PATCH v3] " Jason Hall
2026-02-02  5:38     ` Dirk Behme
2026-02-02 13:56       ` [PATCH v4] " Jason Hall
2026-02-03  6:21         ` Dirk Behme
2026-02-03 15:25           ` Jkhall81
2026-02-03 15:49             ` Onur Özkan
2026-02-03 16:02               ` Gary Guo
2026-02-03 16:32                 ` Onur Özkan
2026-02-03 16:54                   ` Gary Guo
2026-02-04 15:56                     ` Dirk Behme
2026-02-04 18:10                       ` Miguel Ojeda
2026-02-04 19:08                         ` Joe Perches
2026-02-05  1:42                           ` Jason Hall [this message]
2026-02-05 20:55                             ` [PATCH v5] scripts: checkpatch: move Rust-specific lints to separate file Miguel Ojeda
2026-02-06  8:31                               ` Dirk Behme
2026-02-06 17:41                                 ` Miguel Ojeda
2026-02-07 15:56                                   ` [PATCH v6] " Jason Hall
2026-02-07 16:07                                     ` Miguel Ojeda
2026-02-07 16:53                                       ` [PATCH v7] " Jason Hall
2026-02-07 18:46                                         ` Miguel Ojeda
2026-02-07 21:07                                           ` [PATCH v8 0/2] modularize Rust lints and add RUST_UNWRAP check Jason Hall
2026-02-07 21:07                                             ` [PATCH v8 1/2] scripts: checkpatch: move Rust-specific lints to separate file Jason Hall
2026-02-07 21:53                                               ` Miguel Ojeda
2026-02-07 22:49                                                 ` [PATCH v9 0/2] modularize Rust lints and add RUST_UNWRAP check Jason Hall
2026-02-07 22:49                                                   ` [PATCH v9 1/2] scripts: checkpatch: move Rust-specific lints to separate file Jason Hall
2026-02-07 22:49                                                   ` [PATCH v9 2/2] scripts: checkpatch: add RUST_UNWRAP lint Jason Hall
2026-02-08  7:55                                                     ` Dirk Behme
2026-02-08 14:01                                                       ` Jason Hall
2026-02-09  8:52                                                         ` Dirk Behme
2026-02-08  6:43                                                   ` [PATCH v9 0/2] modularize Rust lints and add RUST_UNWRAP check Greg KH
2026-02-14  6:11                                                   ` Dirk Behme
2026-02-14 23:30                                                     ` Miguel Ojeda
2026-02-14 23:32                                                       ` Miguel Ojeda
2026-02-07 21:07                                             ` [PATCH v8 2/2] scripts: checkpatch: add RUST_UNWRAP lint Jason Hall
2026-02-05 13:23                         ` [PATCH v4] scripts: checkpatch: warn on Rust panicking methods Dirk Behme
2026-02-05 21:00                           ` Miguel Ojeda
2026-02-04 18:11               ` Miguel Ojeda
2026-02-01 19:51 ` [PATCH] " Gary Guo

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=20260205014218.2202385-1-jason.kei.hall@gmail.com \
    --to=jason.kei.hall@gmail.com \
    --cc=dirk.behme@gmail.com \
    --cc=gary@garyguo.net \
    --cc=joe@perches.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=work@onurozkan.dev \
    /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

all inboxes | Powered by JetHome®