[v4] rust: doc: Clean up formatting in io.rs

[PATCH v4] rust: doc: Clean up formatting in io.rs

Posted by Sai Vishnu M 6 months, 2 weeks ago

From: Sai Vishnu M <saivishnu725@gmail.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@kernel.org>
Closes:  https://github.com/Rust-for-Linux/linux/issues/1167
Signed-off-by: Sai Vishnu M <saivishnu725@gmail.com>
---
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(-)

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.

base-commit: 7a17bbc1d952057898cb0739e60665908fbb8c72
-- 
2.49.0

Re: [PATCH v4] rust: doc: Clean up formatting in io.rs

Posted by Miguel Ojeda 5 months, 3 weeks ago

On Mon, Jun 2, 2025 at 6:51 PM Sai Vishnu M <saivishnu725@gmail.com> wrote:
>
> From: Sai Vishnu M <saivishnu725@gmail.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@kernel.org>
> Closes:  https://github.com/Rust-for-Linux/linux/issues/1167
> Signed-off-by: Sai Vishnu M <saivishnu725@gmail.com>

Applied to `rust-next` -- thanks!

    [ Reworded title and adjusted tags. - Miguel ]

Danilo: you originally added this, so if you are against this one,
please let me know.

Cheers,
Miguel

Re: [PATCH v4] rust: doc: Clean up formatting in io.rs

Posted by Benno Lossin 6 months, 1 week ago

On Mon Jun 2, 2025 at 6:49 PM CEST, Sai Vishnu M wrote:
> From: Sai Vishnu M <saivishnu725@gmail.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@kernel.org>
> Closes:  https://github.com/Rust-for-Linux/linux/issues/1167
> Signed-off-by: Sai Vishnu M <saivishnu725@gmail.com>

Reviewed-by: Benno Lossin <lossin@kernel.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(-)

Re: [PATCH v4] rust: doc: Clean up formatting in io.rs

Posted by Miguel Ojeda 6 months, 2 weeks ago

On Mon, Jun 2, 2025 at 6:51 PM Sai Vishnu M <saivishnu725@gmail.com> wrote:
>
> From: Sai Vishnu M <saivishnu725@gmail.com>

I think this line should not have been generated by Git, but it should not hurt.

Apart from that, looks good, thanks!

I can pick it up, but if someone else does:

Acked-by: Miguel Ojeda <ojeda@kerrnel.org>

Cheers,
Miguel