summaryrefslogtreecommitdiff
path: root/rust
diff options
context:
space:
mode:
authorMiguel Ojeda <ojeda@kernel.org>2025-10-29 08:14:06 +0100
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2025-11-13 15:37:39 -0500
commite033d62c353b15be9538890264a30f2dd10c74e6 (patch)
tree75c284b41c6ccecf7d261485c713c8164ae59dee /rust
parent923ffdc63503723936cf9c53bb08d1c9f8fc3883 (diff)
downloadlinux-e033d62c353b15be9538890264a30f2dd10c74e6.tar.gz
linux-e033d62c353b15be9538890264a30f2dd10c74e6.tar.bz2
linux-e033d62c353b15be9538890264a30f2dd10c74e6.zip
rust: devres: fix private intra-doc link
commit ff4d2ef3874773c9c6173b0f099372bf62252aaf upstream. 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> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'rust')
-rw-r--r--rust/kernel/devres.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/rust/kernel/devres.rs b/rust/kernel/devres.rs
index d04e3fcebafb..e02e3c0fa645 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>,