rust: io: avoid mentioning private fields in IoMem

saivishnu725 · ojeda · commit 0303584766b7 · 2025-06-24T01:02:30.000+02:00
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: #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
@@ -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.

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ impl<const SIZE: usize> IoRaw<SIZE> {`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
`46`		`-/// IO-mapped memory, starting at the base address @addr and spanning @maxlen bytes.`
	`46`	`+/// IO-mapped memory region.`
`47`	`47`	`///`
`48`	`48`	`/// The creator (usually a subsystem / bus such as PCI) is responsible for creating the`
`49`	`49`	`/// mapping, performing an additional region request etc.`