[PATCH] rust: devres: fix private intra-doc link

[PATCH] rust: devres: fix private intra-doc link

[Miguel Ojeda]

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

    error: public documentation for `Devres` links to private item `Self::inner`
       --> rust/kernel/devres.rs:106:7
        |
    106 | /// [`Self::inner`] is guaranteed to be initialized and is always accessed read-only.
        |       ^^^^^^^^^^^ this item is private
        |
        = note: this link will resolve properly if you pass `--document-private-items`
        = note: `-D rustdoc::private-intra-doc-links` implied by `-D warnings`
        = help: to override `-D warnings` add `#[allow(rustdoc::private_intra_doc_links)]`

Currently, when rendered, the link points to "nowhere" (an inexistent
anchor for a "method").

Thus fix it.

Cc: stable@vger.kernel.org
Fixes: f5d3ef25d238 ("rust: devres: get rid of Devres' inner Arc")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 rust/kernel/devres.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/kernel/devres.rs b/rust/kernel/devres.rs
index 10a6a1789854..2392c281459e 100644
--- a/rust/kernel/devres.rs
+++ b/rust/kernel/devres.rs
@@ -103,7 +103,7 @@ struct Inner<T: Send> {
 ///
 /// # Invariants
 ///
-/// [`Self::inner`] is guaranteed to be initialized and is always accessed read-only.
+/// `Self::inner` is guaranteed to be initialized and is always accessed read-only.
 #[pin_data(PinnedDrop)]
 pub struct Devres<T: Send> {
     dev: ARef<Device>,

base-commit: dcb6fa37fd7bc9c3d2b066329b0d27dedf8becaa
-- 
2.51.0

Re: [PATCH] rust: devres: fix private intra-doc link

[Danilo Krummrich]

On Wed Oct 29, 2025 at 8:14 AM CET, Miguel Ojeda wrote:
> The future move of pin-init to `syn` uncovers the following private
> intra-doc link:

Given that, do you want to take this one through your tree? If so, please do,
otherwise please let me know.

Acked-by: Danilo Krummrich <dakr@kernel.org>

Re: [PATCH] rust: devres: fix private intra-doc link

[Miguel Ojeda]

On Wed, Oct 29, 2025 at 12:39 PM Danilo Krummrich <dakr@kernel.org> wrote:
>
> Given that, do you want to take this one through your tree? If so, please do,
> otherwise please let me know.
>
> Acked-by: Danilo Krummrich <dakr@kernel.org>

Yeah, I sent it independently in case I take it as a fix earlier;
otherwise, I will put it before the `syn` series that will go via
rust-next since it is not an urgent fix anyway.

Thanks for the quick Acked-by!

Cheers,
Miguel

Re: [PATCH] rust: devres: fix private intra-doc link

[Miguel Ojeda]

On Wed, Oct 29, 2025 at 8:15 AM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> The future move of pin-init to `syn` uncovers the following private
> intra-doc link:
>
>     error: public documentation for `Devres` links to private item `Self::inner`
>        --> rust/kernel/devres.rs:106:7
>         |
>     106 | /// [`Self::inner`] is guaranteed to be initialized and is always accessed read-only.
>         |       ^^^^^^^^^^^ this item is private
>         |
>         = note: this link will resolve properly if you pass `--document-private-items`
>         = note: `-D rustdoc::private-intra-doc-links` implied by `-D warnings`
>         = help: to override `-D warnings` add `#[allow(rustdoc::private_intra_doc_links)]`
>
> Currently, when rendered, the link points to "nowhere" (an inexistent
> anchor for a "method").
>
> Thus fix it.
>
> Cc: stable@vger.kernel.org
> Fixes: f5d3ef25d238 ("rust: devres: get rid of Devres' inner Arc")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Applied to `rust-fixes` -- thanks!

Cheers,
Miguel