linux-kernel - Re: [PATCH 1/3] checkpatch.pl: Add warning for // comments on private Rust items

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <ade03ed8-e815-4135-9b75-ac7f58c5693a@arnaud-lcm.com>
Date: Wed, 13 Aug 2025 16:32:41 +0100
From: "Lecomte, Arnaud" <contact@...aud-lcm.com>
To: joe@...ches.com
Cc: apw@...onical.com, dwaipayanray1@...il.com, lukas.bulwahn@...il.com,
 ojeda@...nel.org, alex.gaynor@...il.com, boqun.feng@...il.com,
 gary@...yguo.net, bjorn3_gh@...tonmail.com, lossin@...nel.org,
 a.hindborg@...nel.org, aliceryhl@...gle.com, tmgross@...ch.edu,
 dakr@...nel.org, linux-kernel@...r.kernel.org, rust-for-linux@...r.kernel.org
Subject: Re: [PATCH 1/3] checkpatch.pl: Add warning for // comments on private
 Rust items

Hi !
Just checking in on this patch series. Is there anything I can clarify 
or improve to help move this forward ?

Cheers,
Arnaud

On 29/07/2025 20:56, Arnaud Lecomte wrote:
> Hi,
>
> Background
> ----------
>
> The Rust-for-Linux project currently lacks enforcement of documentation for private Rust items,
> as highlighted in https://github.com/Rust-for-Linux/linux/issues/1157.
> While rustc already lints missing documentation for public items, private items remain unchecked.
> This patch series aims to close that gap by ensuring proper documentation practices
> for private Rust items in the kernel as mentioned in the coding
> guidelines for the Rust linux kernel: Documentation/rust/coding-guidelines.rst.
>
> The actual solution comes in several parts
> ------------------------------------------
>
>   1) Patch 1 : Implements detection logic to emit warnings for improperly
>   documented private Rust items (e.g., // comments instead of ///)
>   through a set of heuristics.
>   2) Patch 2 : Adds an auto-fix mechanism via the --fix option to help
>   developers correct documentation issues.
>
> Link: https://github.com/Rust-for-Linux/linux/issues/1157
> Signed-off-by: Arnaud Lecomte <contact@...aud-lcm.com>
> --
> 2.43.0