Commit f1b55db0 authored by Danilo Krummrich's avatar Danilo Krummrich
Browse files

rust: device: fix unresolved link to drm::Device 



drm::Device is only available when CONFIG_DRM=y, which we have to
consider for intra-doc links, otherwise the rustdoc make target produces
the following warning.

>> warning: unresolved link to `kernel::drm::Device`
   --> rust/kernel/device.rs:154:22
   |
   154 | /// [`drm::Device`]: kernel::drm::Device
   |                      ^^^^^^^^^^^^^^^^^^^ no item named `drm` in module `kernel`
   |
   = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default

Fix this by making the intra-doc link conditional on CONFIG_DRM being enabled.

Fixes: d6e26c1a ("device: rust: expand documentation for Device")
Suggested-by: default avatarAlice Ryhl <aliceryhl@google.com>
Reported-by: default avatarkernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202508261644.9LclwUgt-lkp@intel.com/


Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Acked-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/20250829195745.31174-1-dakr@kernel.org


Signed-off-by: default avatarDanilo Krummrich <dakr@kernel.org>
parent 1b237f19

rust/kernel/device.rs

+3 −2
Original line number Diff line number Diff line
@@ -138,7 +138,9 @@ 
/// }

/// ```

///

/// An example for a class device implementation is [`drm::Device`].

/// An example for a class device implementation is

#[cfg_attr(CONFIG_DRM = "y", doc = "[`drm::Device`](kernel::drm::Device).")]

#[cfg_attr(not(CONFIG_DRM = "y"), doc = "`drm::Device`.")]

///

/// # Invariants

///
@@ -151,7 +153,6 @@ 
/// dropped from any thread.

///

/// [`AlwaysRefCounted`]: kernel::types::AlwaysRefCounted

/// [`drm::Device`]: kernel::drm::Device

/// [`impl_device_context_deref`]: kernel::impl_device_context_deref

/// [`pci::Device`]: kernel::pci::Device

/// [`platform::Device`]: kernel::platform::Device