From: Arnaud Lecomte <contact@arnaud-lcm.com>
To: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Cc: "Andy Whitcroft" <apw@canonical.com>,
"Joe Perches" <joe@perches.com>,
"Dwaipayan Ray" <dwaipayanray1@gmail.com>,
"Lukas Bulwahn" <lukas.bulwahn@gmail.com>,
"Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <benno.lossin@proton.me>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Alice Ryhl" <aliceryhl@google.com>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
"Nathan Chancellor" <nathan@kernel.org>,
"Nick Desaulniers" <nick.desaulniers+lkml@gmail.com>,
"Bill Wendling" <morbo@google.com>,
"Justin Stitt" <justinstitt@google.com>,
linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org,
llvm@lists.linux.dev, skhan@linuxfoundation.org
Subject: Re: [PATCH v3 0/2] checkpatch.pl: Add warning for // comments on private Rust items
Date: Tue, 22 Apr 2025 16:38:53 +0200 [thread overview]
Message-ID: <d2087f2e-7362-493b-ae23-546cd7789f6b@arnaud-lcm.com> (raw)
In-Reply-To: <CANiq72mo+DSyFZ3gVWVhqH5LHa0hkJ6gyTN70=smhRYzpNMYWA@mail.gmail.com>
On 22/04/2025 16:10, Miguel Ojeda wrote:
> On Tue, Apr 22, 2025 at 2:56 PM Arnaud Lecomte <contact@arnaud-lcm.com> wrote:
>> 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.
> I think this background wasn't changed from the previous version --
> you can include a changelog in the cover letter too (some do that
> only, instead of per-patch), which may help to mention what changed in
> the cover letter itself, if any, since this is a good and long cover
> letter :)
>
> By the way, some of this cover letter (the "Results" section in
> particular with the examples) could be nice as part of the commit
> message on the first commit -- that will make it forever part of the
> Git repository, which can be useful to understand the commit itself
> and why you designed the heuristics like you did.
>
> Thanks!
>
> Cheers,
> Miguel
Definitely make sense to be part of the commit message for the first
patch, thanks !
Arnaud
prev parent reply other threads:[~2025-04-22 14:38 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-22 12:56 Arnaud Lecomte
2025-04-22 12:58 ` [PATCH v3 1/2] checkpatch.pl: warn about " Arnaud Lecomte
2025-04-22 13:46 ` Miguel Ojeda
2025-04-22 14:37 ` Arnaud Lecomte
2025-04-22 15:32 ` Miguel Ojeda
2025-04-23 11:33 ` Arnaud Lecomte
2025-05-23 7:15 ` Arnaud Lecomte
2025-04-22 12:58 ` [PATCH v3 3/3] checkpatch.pl: --fix support for `//` comments rust private items Arnaud Lecomte
2025-04-22 13:02 ` [PATCH v3 2/2 resend] " Arnaud Lecomte
2025-04-22 14:10 ` [PATCH v3 0/2] checkpatch.pl: Add warning for // comments on private Rust items Miguel Ojeda
2025-04-22 14:38 ` Arnaud Lecomte [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=d2087f2e-7362-493b-ae23-546cd7789f6b@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=benno.lossin@proton.me \
--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=justinstitt@google.com \
--cc=linux-kernel@vger.kernel.org \
--cc=llvm@lists.linux.dev \
--cc=lukas.bulwahn@gmail.com \
--cc=miguel.ojeda.sandonis@gmail.com \
--cc=morbo@google.com \
--cc=nathan@kernel.org \
--cc=nick.desaulniers+lkml@gmail.com \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=skhan@linuxfoundation.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®