diff options
author | 2025-02-07 14:25:07 +0000 | |
---|---|---|
committer | 2025-03-08 23:04:38 +0100 | |
commit | cd1ed11a6704638e94ccafe0ba1c3b4a11aab8f3 (patch) | |
tree | b61d8b92d90f4d071268e4dd198a800193d4ca84 /rust/kernel/sync/poll.rs | |
parent | scripts: rust: mention file name in error messages (diff) | |
download | wireguard-linux-cd1ed11a6704638e94ccafe0ba1c3b4a11aab8f3.tar.xz wireguard-linux-cd1ed11a6704638e94ccafe0ba1c3b4a11aab8f3.zip |
rust: improve lifetimes markup
Improve lifetimes markup; e.g. from:
/// ... 'a ...
to:
/// ... `'a` ...
This will make lifetimes display as code span with Markdown and make it
more consistent with rest of the docs.
Link: https://github.com/Rust-for-Linux/linux/issues/1138
Signed-off-by: Borys Tyran <borys.tyran@protonmail.com>
Link: https://lore.kernel.org/r/20250207142437.112435-1-borys.tyran@protonmail.com
[ Reworded and changed Closes tag to Link. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Diffstat (limited to 'rust/kernel/sync/poll.rs')
-rw-r--r-- | rust/kernel/sync/poll.rs | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/rust/kernel/sync/poll.rs b/rust/kernel/sync/poll.rs index d5f17153b424..e105477a3cb1 100644 --- a/rust/kernel/sync/poll.rs +++ b/rust/kernel/sync/poll.rs @@ -43,11 +43,11 @@ impl PollTable { /// /// # Safety /// - /// The caller must ensure that for the duration of 'a, the pointer will point at a valid poll + /// The caller must ensure that for the duration of `'a`, the pointer will point at a valid poll /// table (as defined in the type invariants). /// /// The caller must also ensure that the `poll_table` is only accessed via the returned - /// reference for the duration of 'a. + /// reference for the duration of `'a`. pub unsafe fn from_ptr<'a>(ptr: *mut bindings::poll_table) -> &'a mut PollTable { // SAFETY: The safety requirements guarantee the validity of the dereference, while the // `PollTable` type being transparent makes the cast ok. |