Skip to contentSkip to conversation

rust: doc: Clean up formatting in io.rs

PATCH Applied Sai Vishnu M 3 participants 4 messages Jun 2, 2025 – Jun 23, 2025

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 rust: doc: Clean up formatting in io.rs

From: Sai Vishnu M <[email protected]>

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

---
v1: Used backticks instead of @ for parameters

v2: removed reference to the variable entirely.

v3: Moved chanelog to commit message. Used the proper parent commit.

v4: Fixed the patch format with the same commit changes

---
 rust/kernel/io.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rust/kernel/io.rs +1 -1
index 72d80a6f131e..41404c1e17b3 100644
@@ -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

Signature · 1 line
2.49.0
reviewer Reviewed-by on v4 1/1
#2 lore raw
In reply to Sai Vishnu M
Quoted 8 lines · Sai Vishnu M

From: Sai Vishnu M <[email protected]>

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

---
Cheers,
Benno

Quoted 11 lines

---
v1: Used backticks instead of @ for parameters

v2: removed reference to the variable entirely.

v3: Moved chanelog to commit message. Used the proper parent commit.

v4: Fixed the patch format with the same commit changes

---
 rust/kernel/io.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Applied
#3 lore raw
In reply to Sai Vishnu M
Quoted 9 lines · Sai Vishnu M

From: Sai Vishnu M <[email protected]>

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

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