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

From: Sai Vishnu M
Date: Mon Jun 02 2025 - 12:51:30 EST


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>
---
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(-)

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