]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
rust: devres: fix private intra-doc link
authorMiguel Ojeda <ojeda@kernel.org>
Wed, 29 Oct 2025 07:14:06 +0000 (08:14 +0100)
committerMiguel Ojeda <ojeda@kernel.org>
Sun, 2 Nov 2025 22:18:42 +0000 (23:18 +0100)
commitff4d2ef3874773c9c6173b0f099372bf62252aaf
treef667cf167fa956fd022e82721cf891aee7fffca4
parent6146a0f1dfae5d37442a9ddcba012add260bceb0
rust: devres: fix private intra-doc link

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")
Acked-by: Danilo Krummrich <dakr@kernel.org>
Link: https://patch.msgid.link/20251029071406.324511-1-ojeda@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/kernel/devres.rs