From: Benno Lossin <benno.lossin@proton.me>
To: "Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <benno.lossin@proton.me>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Alice Ryhl" <aliceryhl@google.com>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>
Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 11/22] rust: pin-init: fix documentation links
Date: Tue, 04 Mar 2025 22:54:41 +0000 [thread overview]
Message-ID: <20250304225245.2033120-12-benno.lossin@proton.me> (raw)
In-Reply-To: <20250304225245.2033120-1-benno.lossin@proton.me>
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 <benno.lossin@proton.me>
---
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 @@ 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
///
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 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 {
diff --git a/rust/pin-init/src/lib.rs b/rust/pin-init/src/lib.rs
index fd2c4fdd0ca4..4e1c57a358c2 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<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>`]: ../kernel/sync/struct.Arc.html
+//! [`Box<T>`]: ../kernel/alloc/struct.KBox.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>`]: ../kernel/sync/struct.Arc.html
+/// [`Box<T>`]: ../kernel/sync/struct.KBox.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>`]: ../kernel/sync/struct.Arc.html
+/// [`Box<T>`]: ../kernel/sync/struct.KBox.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.
///
--
2.47.2
next prev parent reply other threads:[~2025-03-04 22:54 UTC|newest]
Thread overview: 103+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <xn5HRPkxO91lsoIUAwMnnAvQRCAgmw6nzTZX2DsODS0viAvz_g6B8l3dpYNtcL2jBXySi0DQrVi04b6MY8GbMw==@protonmail.internalid>
2025-03-04 22:52 ` [PATCH 00/22] make pin-init into a standalone crate Benno Lossin
2025-03-04 22:53 ` [PATCH 01/22] rust: init: disable doctests Benno Lossin
2025-03-05 8:51 ` Andreas Hindborg
2025-03-05 12:53 ` Benno Lossin
2025-03-05 13:00 ` Miguel Ojeda
2025-03-05 14:09 ` Andreas Hindborg
2025-03-05 14:31 ` Benno Lossin
2025-03-05 9:17 ` Fiona Behrens
2025-03-04 22:53 ` [PATCH 02/22] rust: move pin-init API into its own directory Benno Lossin
2025-03-05 9:03 ` Andreas Hindborg
2025-03-05 9:17 ` Fiona Behrens
2025-03-04 22:53 ` [PATCH 03/22] rust: add extensions to the pin-init crate and move relevant documentation there Benno Lossin
2025-03-05 9:11 ` Andreas Hindborg
2025-03-05 11:03 ` Benno Lossin
2025-03-05 9:17 ` Fiona Behrens
2025-03-04 22:53 ` [PATCH 04/22] rust: pin-init: move proc-macro documentation into pin-init crate Benno Lossin
2025-03-05 9:18 ` Fiona Behrens
2025-03-05 9:34 ` Andreas Hindborg
2025-03-05 11:05 ` Benno Lossin
2025-03-04 22:53 ` [PATCH 05/22] rust: pin-init: change examples to the user-space version Benno Lossin
2025-03-05 9:19 ` Fiona Behrens
2025-03-05 10:06 ` Andreas Hindborg
2025-03-04 22:53 ` [PATCH 06/22] rust: pin-init: call `try_[pin_]init!` from `[pin_]init!` instead of `__init_internal!` Benno Lossin
2025-03-05 9:19 ` Fiona Behrens
2025-03-05 10:12 ` Andreas Hindborg
2025-03-04 22:54 ` [PATCH 07/22] rust: pin-init: move the default error behavior of `try_[pin_]init` Benno Lossin
2025-03-05 9:21 ` Fiona Behrens
2025-03-05 10:29 ` Andreas Hindborg
2025-03-05 10:47 ` Benno Lossin
2025-03-04 22:54 ` [PATCH 08/22] rust: pin-init: move `InPlaceInit` and impls of `InPlaceWrite` into the kernel crate Benno Lossin
2025-03-05 9:23 ` Fiona Behrens
2025-03-05 11:18 ` Andreas Hindborg
2025-03-05 12:06 ` Benno Lossin
2025-03-05 12:28 ` Andreas Hindborg
2025-03-05 12:37 ` Benno Lossin
2025-03-04 22:54 ` [PATCH 09/22] rust: pin-init: move impl `Zeroable` for `Opaque` and `Option<KBox<T>>` " Benno Lossin
2025-03-05 9:24 ` Fiona Behrens
2025-03-05 11:26 ` Andreas Hindborg
2025-03-05 12:05 ` Benno Lossin
2025-03-05 12:11 ` Alice Ryhl
2025-03-05 12:17 ` Benno Lossin
2025-03-05 12:49 ` Alice Ryhl
2025-03-05 12:51 ` Benno Lossin
2025-03-04 22:54 ` [PATCH 10/22] rust: add `ZeroableOption` and implement it instead of `Zeroable` for `Option<Box<T, A>>` Benno Lossin
2025-03-05 9:25 ` Fiona Behrens
2025-03-05 11:30 ` Andreas Hindborg
2025-03-04 22:54 ` Benno Lossin [this message]
2025-03-05 9:26 ` [PATCH 11/22] rust: pin-init: fix documentation links Fiona Behrens
2025-03-05 11:37 ` Andreas Hindborg
2025-03-05 11:49 ` Benno Lossin
2025-03-04 22:54 ` [PATCH 12/22] rust: pin-init: remove kernel-crate dependency Benno Lossin
2025-03-05 9:27 ` Fiona Behrens
2025-03-05 11:49 ` Andreas Hindborg
2025-03-05 12:00 ` Benno Lossin
2025-03-05 12:27 ` Andreas Hindborg
2025-03-04 22:55 ` [PATCH 13/22] rust: pin-init: change the way the `paste!` macro is called Benno Lossin
2025-03-05 9:28 ` Fiona Behrens
2025-03-05 11:52 ` Andreas Hindborg
2025-03-04 22:55 ` [PATCH 14/22] rust: add pin-init crate build infrastructure Benno Lossin
2025-03-05 11:59 ` Andreas Hindborg
2025-03-05 12:10 ` Benno Lossin
2025-03-05 12:31 ` Andreas Hindborg
2025-03-05 12:50 ` Miguel Ojeda
2025-03-05 13:00 ` Benno Lossin
2025-03-05 14:19 ` Andreas Hindborg
2025-03-05 14:34 ` Benno Lossin
2025-03-05 12:47 ` Miguel Ojeda
2025-03-04 22:55 ` [PATCH 15/22] rust: make pin-init its own crate Benno Lossin
2025-03-05 9:29 ` Fiona Behrens
2025-03-05 12:12 ` Andreas Hindborg
2025-03-05 13:40 ` Benno Lossin
2025-03-05 14:20 ` Andreas Hindborg
2025-03-04 22:55 ` [PATCH 16/22] rust: pin-init: add `std` and `alloc` support from the user-space version Benno Lossin
2025-03-05 9:32 ` Fiona Behrens
2025-03-05 12:22 ` Andreas Hindborg
2025-03-05 13:55 ` Benno Lossin
2025-03-05 14:29 ` Andreas Hindborg
2025-03-05 15:05 ` Benno Lossin
2025-03-05 17:27 ` Andreas Hindborg
2025-03-04 22:55 ` [PATCH 17/22] rust: pin-init: synchronize documentation with " Benno Lossin
2025-03-05 9:33 ` Fiona Behrens
2025-03-05 12:52 ` Andreas Hindborg
2025-03-04 22:55 ` [PATCH 18/22] rust: pin-init: internal: synchronize with " Benno Lossin
2025-03-05 12:56 ` Andreas Hindborg
2025-03-04 22:56 ` [PATCH 19/22] rust: pin-init: miscellaneous synchronization with the " Benno Lossin
2025-03-05 12:57 ` Andreas Hindborg
2025-03-04 22:56 ` [PATCH 20/22] rust: pin-init: add miscellaneous files from " Benno Lossin
2025-03-05 9:35 ` Fiona Behrens
2025-03-05 13:04 ` Andreas Hindborg
2025-03-05 13:37 ` Miguel Ojeda
2025-03-05 13:58 ` Benno Lossin
2025-03-04 22:56 ` [PATCH 21/22] rust: pin-init: re-enable doctests Benno Lossin
2025-03-05 9:35 ` Fiona Behrens
2025-03-05 13:05 ` Andreas Hindborg
2025-03-04 22:56 ` [PATCH 22/22] MAINTAINERS: add entry for the `pin-init` crate Benno Lossin
2025-03-05 0:17 ` Jarkko Sakkinen
2025-03-05 0:43 ` Benno Lossin
2025-03-05 5:14 ` Jarkko Sakkinen
2025-03-04 23:12 ` [PATCH 00/22] make pin-init into a standalone crate Benno Lossin
2025-03-05 13:56 ` Andreas Hindborg
2025-03-05 14:03 ` Benno Lossin
2025-03-05 14:36 ` Andreas Hindborg
2025-03-05 14:47 ` Benno Lossin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250304225245.2033120-12-benno.lossin@proton.me \
--to=benno.lossin@proton.me \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=dakr@kernel.org \
--cc=gary@garyguo.net \
--cc=linux-kernel@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).