From 7b72eade87eb883781d9f9b98e42888dfb13003d Mon Sep 17 00:00:00 2001 From: Philipp Stanner Date: Mon, 4 Mar 2024 12:14:33 +0100 Subject: [PATCH] rust: io_mem.rs: improve IoMem's docstring IoMem's docstring currently states that const generic SIZE specifies an address's size. More precisely, it specifies the size of the memory area the address points to. Improve the wording. Signed-off-by: Philipp Stanner Signed-off-by: Andreas Hindborg --- rust/kernel/io_mem.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/rust/kernel/io_mem.rs b/rust/kernel/io_mem.rs index 0c646ddcf7ea09..14e5c4d2dc8964 100644 --- a/rust/kernel/io_mem.rs +++ b/rust/kernel/io_mem.rs @@ -34,8 +34,9 @@ impl Resource { /// /// # Invariants /// -/// `ptr` is a non-null and valid address of at least `SIZE` bytes and returned by an `ioremap` -/// variant. `ptr` is also 8-byte aligned. +/// `ptr` is a non-null and valid address of a memory area of a length of at +/// least `SIZE` bytes. It is returned by an `ioremap` variant. `ptr` is also +/// 8-byte aligned. /// /// # Examples ///