* [PATCH] rust: condvar: fix broken intra-doc link
@ 2025-10-29 7:33 Miguel Ojeda
2025-10-29 12:45 ` Alice Ryhl
2025-11-02 22:20 ` Miguel Ojeda
0 siblings, 2 replies; 3+ messages in thread
From: Miguel Ojeda @ 2025-10-29 7:33 UTC (permalink / raw)
To: Miguel Ojeda, Alex Gaynor
Cc: Boqun Feng, Gary Guo, Björn Roy Baron, Benno Lossin,
Andreas Hindborg, Alice Ryhl, Trevor Gross, Danilo Krummrich,
rust-for-linux, linux-kernel, patches, stable
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: stable@vger.kernel.org
Fixes: 129e97be8e28 ("rust: pin-init: fix documentation links")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
rust/kernel/sync/condvar.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/rust/kernel/sync/condvar.rs b/rust/kernel/sync/condvar.rs
index c6ec64295c9f..aa5b9a7a726d 100644
--- a/rust/kernel/sync/condvar.rs
+++ b/rust/kernel/sync/condvar.rs
@@ -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
--
2.51.0
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [PATCH] rust: condvar: fix broken intra-doc link
2025-10-29 7:33 [PATCH] rust: condvar: fix broken intra-doc link Miguel Ojeda
@ 2025-10-29 12:45 ` Alice Ryhl
2025-11-02 22:20 ` Miguel Ojeda
1 sibling, 0 replies; 3+ messages in thread
From: Alice Ryhl @ 2025-10-29 12:45 UTC (permalink / raw)
To: Miguel Ojeda
Cc: Alex Gaynor, Boqun Feng, Gary Guo, Björn Roy Baron,
Benno Lossin, Andreas Hindborg, Trevor Gross, Danilo Krummrich,
rust-for-linux, linux-kernel, patches, stable
On Wed, Oct 29, 2025 at 08:33:44AM +0100, Miguel Ojeda wrote:
> 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: stable@vger.kernel.org
> Fixes: 129e97be8e28 ("rust: pin-init: fix documentation links")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] rust: condvar: fix broken intra-doc link
2025-10-29 7:33 [PATCH] rust: condvar: fix broken intra-doc link Miguel Ojeda
2025-10-29 12:45 ` Alice Ryhl
@ 2025-11-02 22:20 ` Miguel Ojeda
1 sibling, 0 replies; 3+ messages in thread
From: Miguel Ojeda @ 2025-11-02 22:20 UTC (permalink / raw)
To: Miguel Ojeda
Cc: Alex Gaynor, Boqun Feng, Gary Guo, Björn Roy Baron,
Benno Lossin, Andreas Hindborg, Alice Ryhl, Trevor Gross,
Danilo Krummrich, rust-for-linux, linux-kernel, patches, stable
On Wed, Oct 29, 2025 at 8:34 AM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> 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: stable@vger.kernel.org
> Fixes: 129e97be8e28 ("rust: pin-init: fix documentation links")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Applied to `rust-fixes` -- thanks!
Cheers,
Miguel
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2025-11-02 22:20 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-29 7:33 [PATCH] rust: condvar: fix broken intra-doc link Miguel Ojeda
2025-10-29 12:45 ` Alice Ryhl
2025-11-02 22:20 ` Miguel Ojeda
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).