From: Sai Vishnu M <saivishnu725@gmail.com>
Date: Mon, 2 Jun 2025 16:49:24 +0000 (+0530)
Subject: rust: io: avoid mentioning private fields in `IoMem`
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=0303584766b7bdb6564c7e8f13e0b59b6ef44984;p=users%2Fwilly%2Fxarray.git

rust: io: avoid mentioning private fields in `IoMem`

Removed reference to internal variables in the comment of `IoMem`
This avoids using private variable names in public documentation.

Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: 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>
Link: https://lore.kernel.org/r/20250602164923.48893-2-saivishnu725@gmail.com
[ Reworded title and adjusted tags. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---

diff --git a/rust/kernel/io.rs b/rust/kernel/io.rs
index c08de4121637..bd4d720be165 100644
--- a/rust/kernel/io.rs
+++ b/rust/kernel/io.rs
@@ -43,7 +43,7 @@ impl<const SIZE: usize> IoRaw<SIZE> {
     }
 }
 
-/// 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.