Commit db7193a5 authored by Ben Gooding's avatar Ben Gooding Committed by Miguel Ojeda
Browse files

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: default avatarBenno 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: default avatarBen Gooding <ben.gooding.dev@gmail.com>
Link: https://lore.kernel.org/r/20230509202314.8248-1-ben.gooding.dev@gmail.com


Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 52a93d39

rust/kernel/sync/lock.rs

+3 −3
Original line number Diff line number Diff line
@@ -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"]