diff options
| author | Ben Gooding <ben.gooding.dev@gmail.com> | 2023-05-07 17:27:39 +0100 |
|---|---|---|
| committer | Miguel Ojeda <ojeda@kernel.org> | 2023-08-07 11:33:33 +0200 |
| commit | db7193a5c9db4babbfc99798f2e636b12419c12b (patch) | |
| tree | 1799eeb3189474b00d6bfc2fc6093a8506f2877d /rust | |
| parent | 52a93d39b17dc7eb98b6aa3edb93943248e03b2f (diff) | |
| download | linux-db7193a5c9db4babbfc99798f2e636b12419c12b.tar.gz linux-db7193a5c9db4babbfc99798f2e636b12419c12b.tar.bz2 linux-db7193a5c9db4babbfc99798f2e636b12419c12b.zip | |
rust: lock: Add intra-doc links to the Backend trait
Add missing intra-doc links to the Backend trait to make navigating the
documentation easier.
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>
Link: https://lore.kernel.org/r/20230509202314.8248-1-ben.gooding.dev@gmail.com
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Diffstat (limited to 'rust')
| -rw-r--r-- | rust/kernel/sync/lock.rs | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/rust/kernel/sync/lock.rs b/rust/kernel/sync/lock.rs index a2216325632d..70a785f04754 100644 --- a/rust/kernel/sync/lock.rs +++ b/rust/kernel/sync/lock.rs @@ -72,8 +72,8 @@ pub unsafe trait Backend { /// A mutual exclusion primitive. /// -/// Exposes one of the kernel locking primitives. Which one is exposed depends on the lock backend -/// specified as the generic parameter `B`. +/// Exposes one of the kernel locking primitives. Which one is exposed depends on the lock +/// [`Backend`] specified as the generic parameter `B`. #[pin_data] pub struct Lock<T: ?Sized, B: Backend> { /// The kernel lock object. @@ -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"] |