Skip to contentSkip to conversation

rust: condvar: fix broken intra-doc link

PATCH Applied Miguel Ojeda 3 participants 3 messages Oct 29, 2025 – Nov 2, 2025

Subsystems (3)
Stable branch Rust Rust sync
lore
Share & tools
lore

Miguel Ojeda

author maintainer
#0 lore raw

PATCH 1/1 rust: condvar: fix broken intra-doc link

The future move of pin-init to syn uncovers the following broken intra-doc link:

error: unresolved link to crate::pin_init
--> rust/kernel/sync/condvar.rs:39:40
|
39 | /// instances is with the [pin_init](crate::pin_init!) and [new_condvar] macros.
| ^^^^^^^^^^^^^^^^ no item named pin_init in module kernel
|
= note: -D rustdoc::broken-intra-doc-links implied by -D warnings
= help: to override -D warnings add #[allow(rustdoc::broken_intra_doc_links)]

Currently, when rendered, the link points to a literal crate::pin_init! URL.

Thus fix it.

Cc [email protected]
Fixes 129e97be8e28 ("rust: pin-init: fix documentation links")
Signed-off-by Miguel Ojeda <[email protected]>
---
 rust/kernel/sync/condvar.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rust/kernel/sync/condvar.rs +1 -1
index c6ec64295c9f..aa5b9a7a726d 100644
@@ -36,7 +36,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`](pin_init::pin_init!) and [`new_condvar`] macros.
 ///
 /// # Examples
 ///

base-commit: dcb6fa37fd7bc9c3d2b066329b0d27dedf8becaa

Signature · 1 line
2.51.0
maintainer Reviewed-by on v1 1/1
#1 lore raw
Quoted 12 lines · Miguel Ojeda

The future move of pin-init to syn uncovers the following broken intra-doc link:

error: unresolved link to crate::pin_init
--> rust/kernel/sync/condvar.rs:39:40
|
39 | /// instances is with the [pin_init](crate::pin_init!) and [new_condvar] macros.
| ^^^^^^^^^^^^^^^^ no item named pin_init in module kernel
|
= note: -D rustdoc::broken-intra-doc-links implied by -D warnings
= help: to override -D warnings add #[allow(rustdoc::broken_intra_doc_links)]

Quoted 8 lines

Currently, when rendered, the link points to a literal crate::pin_init! URL.

Thus fix it.

Cc [email protected]
Fixes 129e97be8e28 ("rust: pin-init: fix documentation links")
Signed-off-by Miguel Ojeda <[email protected]>
Reviewed-by Alice Ryhl <[email protected]>
Applied
#2 lore raw
In reply to Miguel Ojeda
Quoted 13 lines · Miguel Ojeda

The future move of pin-init to syn uncovers the following broken intra-doc link:

error: unresolved link to crate::pin_init
--> rust/kernel/sync/condvar.rs:39:40
|
39 | /// instances is with the [pin_init](crate::pin_init!) and [new_condvar] macros.
| ^^^^^^^^^^^^^^^^ no item named pin_init in module kernel
|
= note: -D rustdoc::broken-intra-doc-links implied by -D warnings
= help: to override -D warnings add #[allow(rustdoc::broken_intra_doc_links)]

Quoted 8 lines

Currently, when rendered, the link points to a literal crate::pin_init! URL.

Thus fix it.

Cc [email protected]
Fixes 129e97be8e28 ("rust: pin-init: fix documentation links")
Signed-off-by Miguel Ojeda <[email protected]>

Applied to rust-fixes -- thanks!

Cheers,
Miguel