Re: [PATCH v4] rust: doc: Clean up formatting in io.rs
From: Benno Lossin
Date: Sun Jun 08 2025 - 03:59:59 EST
On Mon Jun 2, 2025 at 6:49 PM CEST, Sai Vishnu M wrote:
> From: Sai Vishnu M <saivishnu725@xxxxxxxxx>
>
> Removed reference to internal variables in the comment of `IoMem`
> This avoids using private variable names in public documentation.
>
> Reported-by: Miguel Ojeda <ojeda@xxxxxxxxxx>
> Closes: https://github.com/Rust-for-Linux/linux/issues/1167
> Signed-off-by: Sai Vishnu M <saivishnu725@xxxxxxxxx>
Reviewed-by: Benno Lossin <lossin@xxxxxxxxxx>
---
Cheers,
Benno
> ---
> v1: Used backticks instead of `@` for parameters
> link: https://lore.kernel.org/rust-for-linux/20250530123129.31505-2-saivishnu725@xxxxxxxxx/
> v2: removed reference to the variable entirely.
> link: https://lore.kernel.org/rust-for-linux/20250601164939.5306-2-saivishnu725@xxxxxxxxx/
> v3: Moved chanelog to commit message. Used the proper parent commit.
> link: https://lore.kernel.org/rust-for-linux/20250602083119.17752-2-saivishnu725@xxxxxxxxx/
> v4: Fixed the patch format with the same commit changes
> ---
> rust/kernel/io.rs | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)