linux-kernel - Re: [PATCH] docs: rust: Refactor safety lines docs to sections in cpufreq.rs

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: <CANiq72mr7PMMeBGbLSSzS+1TtTwJ6Q0V4n8n=YjeWxuX4tyq4A@mail.gmail.com>
Date: Tue, 10 Jun 2025 18:15:55 +0200
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Oliver Säfström <safstrom.oliver@...il.com>, 
	viresh.kumar@...aro.org
Cc: rafael@...nel.org, 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, rust-for-linux@...r.kernel.org, 
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: rust: Refactor safety lines docs to sections in cpufreq.rs

On Tue, Jun 10, 2025 at 5:18 PM Oliver Säfström
<safstrom.oliver@...il.com> wrote:
>
> Closes: https://github.com/Rust-for-Linux/linux/issues/1169
>
> Signed-off-by: Oliver Säfström <safstrom.oliver@...il.com>
> Suggested-by: Miguel Ojeda <ojeda@...nel.org>

Thanks for the patch Oliver -- Viresh already sent it a bit earlier,
with a few more improvements:

    https://lore.kernel.org/rust-for-linux/4823a58093c6dfa20df62b5c18da613621b9716e.1749554599.git.viresh.kumar@linaro.org/

So I assume he will probably want to go with that one.

But this patch was more of less what I was expecting. Some quick notes
for future patches in case it helps:

  - Commit messages cannot be "empty" in the kernel (not counting
tags). It should explain the "what" and most importantly the "why".

  - It should have been Reported-by in this case, like the issue
mentions, since it is a fix rather than a feature.

  - The tags are usually sorted differently, e.g. please see other
commits in the kernel.

  - I think this patch would make Clippy emit warnings (you can try
with `make ... CLIPPY=1`) because the functions are not `unsafe` (they
should be), e.g.

        warning: safe function's docs have unnecessary `# Safety` section

Thanks again!

Cheers,
Miguel