rust: doc: Clean up formatting in io.rs
Subsystems (2)
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
@@ -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
Quoted 2 lines · Sai Vishnu M
From: Sai Vishnu M <[email protected]>
I think this line should not have been generated by Git, but it should not hurt.
Apart from that, looks good, thanks!
I can pick it up, but if someone else does:
Cheers,
Miguel
Quoted 8 lines · Sai Vishnu M
From: Sai Vishnu M <[email protected]>
Removed reference to internal variables in the comment of
IoMemThis avoids using private variable names in public documentation.Reported-by Miguel Ojeda <[email protected]>Signed-off-by Sai Vishnu M <[email protected]>
---
Cheers,
Benno
Quoted 11 lines
---
v1: Used backticks instead of@for parametersv2: 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(-)
Miguel Ojeda
AppliedQuoted 9 lines · Sai Vishnu M
From: Sai Vishnu M <[email protected]>
Removed reference to internal variables in the comment of
IoMemThis avoids using private variable names in public documentation.Reported-by Miguel Ojeda <[email protected]>Signed-off-by Sai Vishnu M <[email protected]>
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