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

From: saivishnu725
Date: Sun Jun 01 2025 - 12:52:17 EST


From: Sai Vishnu M <saivishnu725@xxxxxxxxx>

Reported-by: Miguel Ojeda <ojeda@xxxxxxxxxx>
Closes: https://github.com/Rust-for-Linux/linux/issues/1167
Signed-off-by: Sai Vishnu M <saivishnu725@xxxxxxxxx>
---
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 92bc4e3cd8ec..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: Edit the doc comment for `IoMem` to remove the usage of
`@` for parameters and replace them with backticks.
Link to v1: https://lkml.org/lkml/2025/5/30/550
v2: Removed reference to internal variables altogether.

Thanks!

2.49.0