Messages in this thread Patch in this message | ![/](/images/icornerl.gif) | | From | Ben Gooding <> | Subject | [PATCH] rust: lock: Add intra-doc links to the Backend trait | Date | Sun, 7 May 2023 16:22:29 +0100 |
| |
Also fix a minor typo in one of the comments
Suggested-by: Benno Lossin <benno.lossin@proton.me> Link: https://lore.kernel.org/rust-for-linux/94625fe6-b87a-a8f0-5b2a-a8152d5f7436@proton.me/ Link: https://github.com/Rust-for-Linux/linux/issues/1001 Signed-off-by: Ben Gooding <ben.gooding.dev@gmail.com> --- rust/kernel/sync/lock.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/rust/kernel/sync/lock.rs b/rust/kernel/sync/lock.rs index a2216325632d..95466201dab7 100644 --- a/rust/kernel/sync/lock.rs +++ b/rust/kernel/sync/lock.rs @@ -72,7 +72,7 @@ pub unsafe trait Backend { /// A mutual exclusion primitive. /// -/// Exposes one of the kernel locking primitives. Which one is exposed depends on the lock backend +/// Exposes one of the kernel locking primitives. Which one is exposed depends on the lock [backend](Backend) /// specified as the generic parameter `B`. #[pin_data] pub struct Lock<T: ?Sized, B: Backend> { @@ -90,7 +90,7 @@ pub struct Lock<T: ?Sized, B: Backend> { pub(crate) data: UnsafeCell<T>, } -// SAFETY: `Lock` can be transferred across thread boundaries iff the data it protects can. +// SAFETY: `Lock` can be transferred across thread boundaries if the data it protects can. unsafe impl<T: ?Sized + Send, B: Backend> Send for Lock<T, B> {} // SAFETY: `Lock` serialises the interior mutability it provides, so it is `Sync` as long as the @@ -126,7 +126,7 @@ impl<T: ?Sized, B: Backend> Lock<T, B> { /// A lock guard. /// -/// Allows mutual exclusion primitives that implement the `Backend` trait to automatically unlock +/// Allows mutual exclusion primitives that implement the [`Backend`] trait to automatically unlock /// when a guard goes out of scope. It also provides a safe and convenient way to access the data /// protected by the lock. #[must_use = "the lock unlocks immediately when the guard is unused"] -- 2.34.1
| ![\](/images/icornerr.gif) |