linux-kernel - Re: [PATCH] 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] [thread-next>] [day] [month] [year] [list]

Message-Id: <DA9QL5A8747E.17QE50WBD6JOT@kernel.org>
Date: Fri, 30 May 2025 21:19:39 +0200
From: "Benno Lossin" <lossin@...nel.org>
To: <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] rust: doc: Clean up formatting in io.rs

On Fri May 30, 2025 at 2:31 PM CEST, saivishnu725 wrote:
> From: Sai Vishnu M <saivishnu725@...il.com>
>
> Replace `@` with backticks in a comment of `io.rs` to follow Rust doc
> convention
>
> 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>
> ---
>  rust/kernel/io.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/rust/kernel/io.rs b/rust/kernel/io.rs
> index 72d80a6f131e..92bc4e3cd8ec 100644
> --- a/rust/kernel/io.rs
> +++ b/rust/kernel/io.rs
> @@ -43,7 +43,7 @@ pub fn maxsize(&self) -> usize {
>      }
>  }
>  
> -/// IO-mapped memory, starting at the base address @addr and spanning @maxlen bytes.
> +/// IO-mapped memory, starting at the base address `addr` and spanning `maxlen` bytes.

I would just remove the second part of the sentence. This is a struct
and its only field is an `IoRaw`, which does have those two fields, but
they are private, so nobody reading the docs will benefit from knowing
this.

---
Cheers,
Benno

>  ///
>  /// The creator (usually a subsystem / bus such as PCI) is responsible for creating the
>  /// mapping, performing an additional region request etc.