Skip to content

Commit 7b72ead

Browse files
Philipp Stannermetaspace
Philipp Stanner
authored andcommitted
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 <[email protected]> Signed-off-by: Andreas Hindborg <[email protected]>
1 parent 11d003d commit 7b72ead

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

rust/kernel/io_mem.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@ impl Resource {
3434
///
3535
/// # Invariants
3636
///
37-
/// `ptr` is a non-null and valid address of at least `SIZE` bytes and returned by an `ioremap`
38-
/// variant. `ptr` is also 8-byte aligned.
37+
/// `ptr` is a non-null and valid address of a memory area of a length of at
38+
/// least `SIZE` bytes. It is returned by an `ioremap` variant. `ptr` is also
39+
/// 8-byte aligned.
3940
///
4041
/// # Examples
4142
///

0 commit comments

Comments
 (0)