From: "Lecomte, Arnaud" <contact@arnaud-lcm.com>
To: joe@perches.com
Cc: apw@canonical.com, dwaipayanray1@gmail.com,
lukas.bulwahn@gmail.com, ojeda@kernel.org, alex.gaynor@gmail.com,
boqun.feng@gmail.com, gary@garyguo.net, bjorn3_gh@protonmail.com,
lossin@kernel.org, a.hindborg@kernel.org, aliceryhl@google.com,
tmgross@umich.edu, dakr@kernel.org, linux-kernel@vger.kernel.org,
rust-for-linux@vger.kernel.org
Subject: Re: [PATCH 1/3] checkpatch.pl: Add warning for // comments on private Rust items
Date: Wed, 13 Aug 2025 16:32:41 +0100 [thread overview]
Message-ID: <ade03ed8-e815-4135-9b75-ac7f58c5693a@arnaud-lcm.com> (raw)
In-Reply-To: <20250729195615.34707-1-contact@arnaud-lcm.com>
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@arnaud-lcm.com>
> --
> 2.43.0
prev parent reply other threads:[~2025-08-13 15:32 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-29 19:56 Arnaud Lecomte
2025-07-29 20:01 ` [PATCH 2/3] checkpatch.pl: warn about " Arnaud Lecomte
2025-07-29 20:04 ` [PATCH 3/3] checkpatch.pl: --fix support for `//` comments rust private items Arnaud Lecomte
2025-07-29 20:23 ` [PATCH 1/3] checkpatch.pl: Add warning for // comments on private Rust items Miguel Ojeda
2025-07-29 20:29 ` Lecomte, Arnaud
2025-08-13 15:32 ` Lecomte, Arnaud [this message]
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=ade03ed8-e815-4135-9b75-ac7f58c5693a@arnaud-lcm.com \
--to=contact@arnaud-lcm.com \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=apw@canonical.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=dakr@kernel.org \
--cc=dwaipayanray1@gmail.com \
--cc=gary@garyguo.net \
--cc=joe@perches.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
/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®