diff options
author | Borys Tyran <borys.tyran@protonmail.com> | 2025-02-07 14:25:07 +0000 |
---|---|---|
committer | Miguel Ojeda <ojeda@kernel.org> | 2025-03-08 23:04:38 +0100 |
commit | cd1ed11a6704638e94ccafe0ba1c3b4a11aab8f3 (patch) | |
tree | b61d8b92d90f4d071268e4dd198a800193d4ca84 /rust/kernel/fs/file.rs | |
parent | fbefae55991f688f5f1615af30fe64823076b072 (diff) | |
download | linux-cd1ed11a6704638e94ccafe0ba1c3b4a11aab8f3.tar.gz linux-cd1ed11a6704638e94ccafe0ba1c3b4a11aab8f3.tar.bz2 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/fs/file.rs')
-rw-r--r-- | rust/kernel/fs/file.rs | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/rust/kernel/fs/file.rs b/rust/kernel/fs/file.rs index e03dbe14d62a..ed57e0137cdb 100644 --- a/rust/kernel/fs/file.rs +++ b/rust/kernel/fs/file.rs @@ -267,7 +267,7 @@ impl LocalFile { /// # Safety /// /// * The caller must ensure that `ptr` points at a valid file and that the file's refcount is - /// positive for the duration of 'a. + /// positive for the duration of `'a`. /// * The caller must ensure that if there is an active call to `fdget_pos` that did not take /// the `f_pos_lock` mutex, then that call is on the current thread. #[inline] @@ -341,7 +341,7 @@ impl File { /// # Safety /// /// * The caller must ensure that `ptr` points at a valid file and that the file's refcount is - /// positive for the duration of 'a. + /// positive for the duration of `'a`. /// * The caller must ensure that if there are active `fdget_pos` calls on this file, then they /// took the `f_pos_lock` mutex. #[inline] |