From 129e97be8e2856884e01340e4070c003345e1cdc Mon Sep 17 00:00:00 2001 From: Benno Lossin Date: Sat, 8 Mar 2025 11:04:48 +0000 Subject: [PATCH] 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: Benno Lossin Reviewed-by: Fiona Behrens Tested-by: Andreas Hindborg Link: https://lore.kernel.org/r/20250308110339.2997091-12-benno.lossin@proton.me Signed-off-by: Miguel Ojeda --- rust/kernel/sync/condvar.rs | 2 +- rust/pin-init/src/__internal.rs | 4 ++-- rust/pin-init/src/lib.rs | 19 +++++++++++-------- 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/rust/kernel/sync/condvar.rs b/rust/kernel/sync/condvar.rs index 7df565038d7d..5aa7fa7c7002 100644 --- a/rust/kernel/sync/condvar.rs +++ b/rust/kernel/sync/condvar.rs @@ -37,7 +37,7 @@ pub use 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 /// diff --git a/rust/pin-init/src/__internal.rs b/rust/pin-init/src/__internal.rs index 74329cc3262c..0db800819681 100644 --- a/rust/pin-init/src/__internal.rs +++ b/rust/pin-init/src/__internal.rs @@ -135,7 +135,7 @@ unsafe impl HasInitData for T { /// /// 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 { value: MaybeUninit, is_init: bool, @@ -156,7 +156,7 @@ impl StackInit { /// Creates a new [`StackInit`] 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 { diff --git a/rust/pin-init/src/lib.rs b/rust/pin-init/src/lib.rs index ca6be982b522..47954bc1dc2f 100644 --- a/rust/pin-init/src/lib.rs +++ b/rust/pin-init/src/lib.rs @@ -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`], -//! [`KBox`] or any other smart pointer that supports this library). +//! [`Box`] 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`]: crate::sync::Arc +//! [`Arc`]: https://rust.docs.kernel.org/kernel/sync/struct.Arc.html +//! [`Box`]: https://rust.docs.kernel.org/kernel/alloc/kbox/struct.Box.html //! [`impl PinInit`]: PinInit //! [`impl PinInit`]: PinInit //! [`impl Init`]: 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`]: 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`], [`Arc`] or even the stack (see [`stack_pin_init!`]). +/// be [`Box`], [`Arc`] 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`]: crate::sync::Arc +/// [`Arc`]: https://rust.docs.kernel.org/kernel/sync/struct.Arc.html +/// [`Box`]: 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: Sized { /// Initializes `slot`. @@ -968,7 +970,7 @@ where /// An initializer for `T`. /// /// To use this initializer, you will need a suitable memory location that can hold a `T`. This can -/// be [`KBox`], [`Arc`] or even the stack (see [`stack_pin_init!`]). Because +/// be [`Box`], [`Arc`] or even the stack (see [`stack_pin_init!`]). Because /// [`PinInit`] is a super trait, you can use every function that takes it as well. /// /// Also see the [module description](self). @@ -992,7 +994,8 @@ where /// Contrary to its supertype [`PinInit`] the caller is allowed to /// move the pointee after initialization. /// -/// [`Arc`]: crate::sync::Arc +/// [`Arc`]: https://rust.docs.kernel.org/kernel/sync/struct.Arc.html +/// [`Box`]: 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: PinInit { /// Initializes `slot`. @@ -1272,7 +1275,7 @@ pub trait InPlaceWrite { /// /// 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. /// -- 2.50.1