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

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

[saivishnu725]

From: Sai Vishnu M <saivishnu725@gmail.com>

Reported-by: Miguel Ojeda <ojeda@kernel.org>
Closes: https://github.com/Rust-for-Linux/linux/issues/1167
Signed-off-by: Sai Vishnu M <saivishnu725@gmail.com>
---
 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

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

[Miguel Ojeda]

On Sun, Jun 1, 2025 at 6:52 PM <saivishnu725@gmail.com> wrote:
>
> From: Sai Vishnu M <saivishnu725@gmail.com>

This "From" line is fine, but it is best to avoid it by configuring
your setup in a way that the From email header matches your Git
author. In other words, the email author is now just
"<saivishnu725@gmail.com>", without your name.

>

The commit message is empty -- the kernel requires providing an
explanation which typically includes the "what" and the "why". In
trivial patches like this one it may seem pointless, but still, it is
good to explain the change :)

> -/// IO-mapped memory, starting at the base address `addr` and spanning `maxlen` bytes.

This appears to be the line from v1 -- the patch should apply against
the tree, not against the previous version of the patch. In other
words, patch versions are like rebased, rather than stacked.

> +/// IO-mapped memory region.

The change itself looks good to me, thanks!

> 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

Please prefer lore.kernel.org for links.

> v2: Removed reference to internal variables altogether.
>
> Thanks!
>
> 2.49.0

The changelog (and any other comments) normally goes after the `---`
line (before the diffstat), rather than at the bottom.

By the way, since we will need a v3 to fix these bits, could you
please try the `--base` flag? It is always nice to know against which
commit a patch is generated, even if in cases like this is obvious,
and helps other tooling (e.g. testing bots).

Thanks for the patch!

Cheers,
Miguel