Commit 129e97be authored by Benno Lossin's avatar Benno Lossin Committed by Miguel Ojeda
Browse files

rust: pin-init: fix documentation links 



Before switching to compile the `pin-init` crate directly, change
any links that would be invalid to links that are valid both before and
after the switch.

Signed-off-by: default avatarBenno Lossin <benno.lossin@proton.me>
Reviewed-by: default avatarFiona Behrens <me@kloenk.dev>
Tested-by: default avatarAndreas Hindborg <a.hindborg@kernel.org>
Link: https://lore.kernel.org/r/20250308110339.2997091-12-benno.lossin@proton.me


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

rust/kernel/sync/condvar.rs

+1 −1
Original line number Diff line number Diff line
@@ -37,7 +37,7 @@ macro_rules! new_condvar { 
/// spuriously.

///

/// Instances of [`CondVar`] need a lock class and to be pinned. The recommended way to create such

/// instances is with the [`pin_init`](crate::pin_init) and [`new_condvar`] macros.

/// instances is with the [`pin_init`](crate::pin_init!) and [`new_condvar`] macros.

///

/// # Examples

///

rust/pin-init/src/__internal.rs

+2 −2
Original line number Diff line number Diff line
@@ -135,7 +135,7 @@ unsafe fn __init_data() -> Self::InitData { 
///

/// If `self.is_init` is true, then `self.value` is initialized.

///

/// [`stack_pin_init`]: kernel::stack_pin_init

/// [`stack_pin_init`]: crate::stack_pin_init

pub struct StackInit<T> {

    value: MaybeUninit<T>,

    is_init: bool,
@@ -156,7 +156,7 @@ impl<T> StackInit<T> { 
    /// Creates a new [`StackInit<T>`] that is uninitialized. Use [`stack_pin_init`] instead of this

    /// primitive.

    ///

    /// [`stack_pin_init`]: kernel::stack_pin_init

    /// [`stack_pin_init`]: crate::stack_pin_init

    #[inline]

    pub fn uninit() -> Self {

        Self {

rust/pin-init/src/lib.rs

+11 −8
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ 
//! To initialize a `struct` with an in-place constructor you will need two things:

//! - an in-place constructor,

//! - a memory location that can hold your `struct` (this can be the [stack], an [`Arc<T>`],

//!   [`KBox<T>`] or any other smart pointer that supports this library).

//!   [`Box<T>`] or any other smart pointer that supports this library).

//!

//! To get an in-place constructor there are generally three options:

//! - directly creating an in-place constructor using the [`pin_init!`] macro,
@@ -204,7 +204,8 @@ 
//! [structurally pinned fields]:

//!     https://doc.rust-lang.org/std/pin/index.html#pinning-is-structural-for-field

//! [stack]: crate::stack_pin_init

//! [`Arc<T>`]: crate::sync::Arc

//! [`Arc<T>`]: https://rust.docs.kernel.org/kernel/sync/struct.Arc.html

//! [`Box<T>`]: https://rust.docs.kernel.org/kernel/alloc/kbox/struct.Box.html

//! [`impl PinInit<Foo>`]: PinInit

//! [`impl PinInit<T, E>`]: PinInit

//! [`impl Init<T, E>`]: Init
@@ -661,7 +662,7 @@ macro_rules! stack_try_pin_init { 
/// });

/// ```

///

/// [`try_pin_init!`]: kernel::try_pin_init

/// [`try_pin_init!`]: crate::try_pin_init

/// [`NonNull<Self>`]: core::ptr::NonNull

// For a detailed example of how this macro works, see the module documentation of the hidden

// module `__internal` inside of `init/__internal.rs`.
@@ -885,7 +886,7 @@ macro_rules! assert_pinned { 
/// A pin-initializer for the type `T`.

///

/// To use this initializer, you will need a suitable memory location that can hold a `T`. This can

/// be [`KBox<T>`], [`Arc<T>`] or even the stack (see [`stack_pin_init!`]).

/// be [`Box<T>`], [`Arc<T>`] or even the stack (see [`stack_pin_init!`]).

///

/// Also see the [module description](self).

///
@@ -902,7 +903,8 @@ macro_rules! assert_pinned { 
///     - `slot` is not partially initialized.

/// - while constructing the `T` at `slot` it upholds the pinning invariants of `T`.

///

/// [`Arc<T>`]: crate::sync::Arc

/// [`Arc<T>`]: https://rust.docs.kernel.org/kernel/sync/struct.Arc.html

/// [`Box<T>`]: https://rust.docs.kernel.org/kernel/alloc/kbox/struct.Box.html

#[must_use = "An initializer must be used in order to create its value."]

pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {

    /// Initializes `slot`.
@@ -968,7 +970,7 @@ unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), E> { 
/// An initializer for `T`.

///

/// To use this initializer, you will need a suitable memory location that can hold a `T`. This can

/// be [`KBox<T>`], [`Arc<T>`] or even the stack (see [`stack_pin_init!`]). Because

/// be [`Box<T>`], [`Arc<T>`] or even the stack (see [`stack_pin_init!`]). Because

/// [`PinInit<T, E>`] is a super trait, you can use every function that takes it as well.

///

/// Also see the [module description](self).
@@ -992,7 +994,8 @@ unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), E> { 
/// Contrary to its supertype [`PinInit<T, E>`] the caller is allowed to

/// move the pointee after initialization.

///

/// [`Arc<T>`]: crate::sync::Arc

/// [`Arc<T>`]: https://rust.docs.kernel.org/kernel/sync/struct.Arc.html

/// [`Box<T>`]: https://rust.docs.kernel.org/kernel/alloc/kbox/struct.Box.html

#[must_use = "An initializer must be used in order to create its value."]

pub unsafe trait Init<T: ?Sized, E = Infallible>: PinInit<T, E> {

    /// Initializes `slot`.
@@ -1272,7 +1275,7 @@ pub trait InPlaceWrite<T> { 
///

/// This trait must be implemented via the [`pinned_drop`] proc-macro attribute on the impl.

///

/// [`pinned_drop`]: kernel::macros::pinned_drop

/// [`pinned_drop`]: crate::macros::pinned_drop

pub unsafe trait PinnedDrop: __internal::HasPinData {

    /// Executes the pinned destructor of this type.

    ///