linux-kernel - Re: [PATCH v3] 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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <2025060244-dragster-unknowing-23f0@gregkh>
Date: Mon, 2 Jun 2025 11:34:18 +0200
From: Greg KH <gregkh@...uxfoundation.org>
To: Sai Vishnu M <saivishnu725@...il.com>
Cc: rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.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, daniel.almeida@...labora.com, me@...enk.dev
Subject: Re: [PATCH v3] rust: doc: Clean up formatting in io.rs

On Mon, Jun 02, 2025 at 02:01:20PM +0530, 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>
> ---
>  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..41404c1e17b3 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 region.
>  ///
>  /// The creator (usually a subsystem / bus such as PCI) is responsible for creating the
>  /// mapping, performing an additional region request etc.
> 
> 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 changelog to commit message. Used the proper parent commit.

All of this "version" text needs to below the first --- line, as the
kernel documentation describes.  Putting it down here makes it so the
patch will not apply at all :(

thanks,

greg k-h