From nobody Sun Feb 8 00:50:02 2026 Received: from mail-pg1-f172.google.com (mail-pg1-f172.google.com [209.85.215.172]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id AF5FA31A7FB for ; Tue, 13 Jan 2026 21:10:28 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.172 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1768338630; cv=none; b=qu2LiZ4Omooxz8fQmdJ6dZ66FBwXKDAizUAS+0lOjfrpE/o/2BIadb29icLzS8KTFJrLU1qHJmrVzVfDi46peKKyC6J/JAAOMDhksxndors7iEftVTYnK+XZJByotuKtRRyru5pAvFUzAodOziYXuMz8rKpL3iMC0lchabqhbCk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1768338630; c=relaxed/simple; bh=nYSR98aCQFnWtxzT16o6zqxKZ/dLmZwdrr5XfgbvdVE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=jz2+A+yJpgjLsHwh09gxkDPwc5tqxZAtrNIl36AEHy/F9rByLio1JdMS//s0VyBtKzrIiI6WcD4TmRZY1y7+NV+YPjGWy+sGQGDIiJiwLIJJ9BH8fdqVo1I6Oja9+jbo6Es0w18Lf2s1bUcdUehjxq6umsO6usWPNefswG1htPI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=aee8+gyR; arc=none smtp.client-ip=209.85.215.172 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="aee8+gyR" Received: by mail-pg1-f172.google.com with SMTP id 41be03b00d2f7-c227206e6dcso5111446a12.2 for ; Tue, 13 Jan 2026 13:10:28 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1768338628; x=1768943428; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=50PrcAaqBfL5mCsWE6bSE1QitHvKwqM43RLRqrMTJnM=; b=aee8+gyRcCNn6dh2tsvEa4zltMzAAk57iYI8TO9b9BtH8IifKWB6RhgTWilvvaCW4W l4LtPIULV/jd26uqVX/MXw5JLWMIV4QaJBMzjgloVpFk0duZT02RWPk9CufnIXyVM7Fo Fpp6LYvpLafgx4XaD6oa9Dse/6Z1sAKGh9HH4i9OYESU1+7AylbePwTPl/R/ZzlIzR+d /C/PXsmYkGov+LTNNj+NrXCCEfMSkFQtCnK67+WP6RPMgOGKYVwJvdUgcnvoUYYPsYmM B+TVyRcyNPXel7J7AmoyRZ7kWWMw2bzcz0bPibhYk3OxVoHOb9+zbwaqjRcEYKe/m4Wc ACWA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1768338628; x=1768943428; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=50PrcAaqBfL5mCsWE6bSE1QitHvKwqM43RLRqrMTJnM=; b=UCTBJ/lQd4a72HawrTm0dGbL1+fuZvzubhhkhZQGSpa0x8zKEkyRgrGO0m5l/X8Xcg AqBqBpC65yoSp/yO4Op8waMoeoxKltaHaSKfebj7IByL8EuJFDQYo8yQdAXTO3q9qpiY Gp+KpLpxJb4/HUoBeSO24ez4RL7we9+LOr6OBJEDyqqVfBPuQKSgIE47t7z1g7PgG9Yl aDTggVOciRjL80OuzdnNLeTs+2xlSGXRT/LMI3gFftyJ98r139I+9bz2QwOldGfuVMac wzgHVnBVTsrZm4pWvzoFfzCcn/WVDEVvdzHF+GYjN51gO/6uuk0henKDPiXzzcHXx4Je Y2ig== X-Forwarded-Encrypted: i=1; AJvYcCXgUWjv4xOJVQ/2/7bts/pa+J0oR36G3o5dO7rZKscEH7ersdSD6bym0rtkzWqINokbXQIjI7g6B2Mb5Kw=@vger.kernel.org X-Gm-Message-State: AOJu0Yzn6vZKuxYntmavOyLw8CVRgXBq8R93yGyWufx1ZfrJvm9Ai8Hl kzs4C2o6HMxu+Z0cm4Bag5XtM0rMX9Dr7rP7d70XkquqLqz+FO48eJcL X-Gm-Gg: AY/fxX6/RvMHXYG+K78oxjBN22K+LLgxkpFPC50URbMWaQXZI420guFXM8RHkOU4L+W /cn/9sM4iNDnwM/XwAIg2yRLZB0FPvyNIGsOWmBUgwQPtqznR5xHzS6cC2+EMo1AtZMYu6mYMno fON0OkxgIsyIWAl01NH3zolbiplddUmqTo6jbTHYcLgW6oGbdCG8uEp+RrSh1CYHE+597ZuJ09T WRW6+elFCwMafzGTc+ZQl0fPm35vg/aGlc4my+cNdrg0rBbQnV8HbJR0jfadktV49tNudVC6j58 TE2ibu+7VN3wqJagg3PpmOh6kq5qgKkHAhASEcseUmttU2zh0mqEuryNoOmvVWq/jobOu60yZDU IpF/R/pkqvK0C/EExaPMWbANT9tOlXFTPG8DYgbiRBbHiBQeXv+vnfboLxDoJeeotK+xLaO4PRo ObSAuX+alTw8i0j32Ib74p67Q1DJrHETk3IL/yy42RKiiLZ9EfZevFIn8s7eTV7w== X-Received: by 2002:a17:903:22d0:b0:26d:d860:3dae with SMTP id d9443c01a7336-2a599da5ddamr3426495ad.3.1768338627905; Tue, 13 Jan 2026 13:10:27 -0800 (PST) Received: from kailas.hsd1.or.comcast.net ([2601:1c2:1803:3ab0::73b]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2a3e3cd4401sm211759035ad.92.2026.01.13.13.10.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 13 Jan 2026 13:10:27 -0800 (PST) From: Ryan Foster To: joe@perches.com Cc: foster.ryan.r@gmail.com, linux-kernel@vger.kernel.org, ojeda@kernel.org, rust-for-linux@vger.kernel.org Subject: [PATCH v2] checkpatch: warn on Rust comments with rustdoc links above items Date: Tue, 13 Jan 2026 13:10:25 -0800 Message-ID: <20260113211025.637889-1-foster.ryan.r@gmail.com> X-Mailer: git-send-email 2.52.0 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add a check to emit a warning when a `//` comment containing rustdoc link patterns (like [`Foo`]) appears directly above a Rust item declaration. This likely indicates the comment should use `///` documentation syntax instead. The check uses heuristics to reduce false positives: - Only triggers on comments with rustdoc link syntax [`...`] - Excludes doc comments (/// and //!) - Excludes special comments (SAFETY:, TODO:, FIXME:, NOTE:, INVARIANT:, INVARIANTS:, NB:, CAST:, GUARANTEE:, GUARANTEES:, PANIC:, OVERFLOW:, BOUNDS:, etc.) - Only warns when directly above a Rust item (fn, struct, enum, etc.) Examples that trigger the warning: // Returns a reference to the underlying [`Table`]. fn table(&self) -> &Table { } Examples that do NOT trigger: // SAFETY: The `ptr` is guaranteed by the C code to be valid. unsafe fn foo() { } // TODO: fix this later fn bar() { } // Regular comment without rustdoc links fn baz() { } v2: Apply suggestions from Joe Perches: - Exclude /// and //! doc comments using negative lookahead - Add more special comment tags found in tree (NB:, INVARIANTS:, CAST:, GUARANTEES:, PANIC:, OVERFLOW:, GUARANTEE:, BOUNDS:) Link: https://github.com/Rust-for-Linux/linux/issues/1157 Suggested-by: Miguel Ojeda Suggested-by: Joe Perches Signed-off-by: Ryan Foster --- scripts/checkpatch.pl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 1b09b9194c94..a5a462827aba 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -3926,12 +3926,12 @@ sub process { # Warn when a // comment that looks like documentation (contains rustdoc # link patterns like [`Foo`]) appears directly above a Rust item. if ($realfile =3D~ /\.rs$/ && - $rawline =3D~ /^\+(\s*)\/\/\s+(.*)$/) { - my $comment_text =3D $2; + $rawline =3D~ m{^\+\s*//(?![/!])(.*)}s) { + my $comment_text =3D $1; # Check if this looks like a doc comment (contains rustdoc link pattern= s) # and is NOT a special comment like SAFETY:, TODO:, FIXME:, etc. if ($comment_text =3D~ /\[`[^\]]+`\]/ && - $comment_text !~ /^\s*(?:SAFETY|TODO|FIXME|NOTE|XXX|HACK|BUG|INVARI= ANT):/) { + $comment_text !~ /^\s*(?:SAFETY|TODO|FIXME|NOTE|XXX|HACK|BUG|INVARI= ANTS?|NB|CAST|GUARANTEES?|PANIC|OVERFLOW|BOUNDS):/) { # Check if next line starts a Rust item my $nextline =3D $rawlines[$linenr]; if (defined($nextline) && --=20 2.52.0