linux-kernel - Re: [PATCH v4] rust: doc: Clean up formatting in io.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: <DAGZRFQ2YFFV.1OJBPD71DJ0BX@kernel.org>
Date: Sun, 08 Jun 2025 09:59:42 +0200
From: "Benno Lossin" <lossin@...nel.org>
To: "Sai Vishnu M" <saivishnu725@...il.com>,
 <rust-for-linux@...r.kernel.org>
Cc: <linux-kernel@...r.kernel.org>, <ojeda@...nel.org>,
 <alex.gaynor@...il.com>, <boqun.feng@...il.com>, <gary@...yguo.net>,
 <bjorn3_gh@...tonmail.com>, <a.hindborg@...nel.org>,
 <aliceryhl@...gle.com>, <tmgross@...ch.edu>, <dakr@...nel.org>,
 <gregkh@...uxfoundation.org>, <daniel.almeida@...labora.com>,
 <me@...enk.dev>
Subject: Re: [PATCH v4] rust: doc: Clean up formatting in io.rs

On Mon Jun 2, 2025 at 6:49 PM CEST, Sai Vishnu M wrote:
> From: Sai Vishnu M <saivishnu725@...il.com>
>
> Removed reference to internal variables in the comment of `IoMem`
> This avoids using private variable names in public documentation.
>
> Reported-by: Miguel Ojeda <ojeda@...nel.org>
> Closes:  https://github.com/Rust-for-Linux/linux/issues/1167
> Signed-off-by: Sai Vishnu M <saivishnu725@...il.com>

Reviewed-by: Benno Lossin <lossin@...nel.org>

---
Cheers,
Benno

> ---
> v1: Used backticks instead of `@` for parameters
> link: https://lore.kernel.org/rust-for-linux/20250530123129.31505-2-saivishnu725@gmail.com/
> v2: removed reference to the variable entirely.
> link: https://lore.kernel.org/rust-for-linux/20250601164939.5306-2-saivishnu725@gmail.com/
> v3: Moved chanelog to commit message. Used the proper parent commit.
> link: https://lore.kernel.org/rust-for-linux/20250602083119.17752-2-saivishnu725@gmail.com/
> v4: Fixed the patch format with the same commit changes
> ---
>  rust/kernel/io.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)