rust: device: fix unresolved link to drm::Device
Subsystems (2)
Danilo Krummrich
maintainerPATCH 1/1 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.
Quoted 1 line
Quoted 1 line
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.
--- rust/kernel/device.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
rust/kernel/device.rs +3 -2
@@ -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
base-commit: 1b237f190eb3d36f52dffe07a40b5eb210280e00
Signature · 1 line
2.51.0
Quoted 14 lines · Danilo Krummrich
drm::Deviceis only available whenCONFIG_DRM=y, which we have to consider for intra-doc links, otherwise the rustdoc make target produces the following warning.Quoted 1 line
Quoted 1 line
warning: unresolved link to
kernel::drm::Device-->
rust/kernel/device.rs:154:22
|
154 | /// [drm::Device]:kernel::drm::Device
| ^^^^^^^^^^^^^^^^^^^ no item nameddrmin modulekernel
|
= note:#[warn(rustdoc::broken_intra_doc_links)]on by defaultFix this by making the intra-doc link conditional on
CONFIG_DRMbeing enabled.
Quoted 8 lines
Fixes d6e26c1ae4a6 ("device: rust: expand documentation for Device")Suggested-by Alice Ryhl <[email protected]>Reported-by kernel test robot <[email protected]>Signed-off-by Danilo Krummrich <[email protected]>--- rust/kernel/device.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
Quoted 13 lines · Danilo Krummrich
drm::Deviceis only available whenCONFIG_DRM=y, which we have to consider for intra-doc links, otherwise the rustdoc make target produces the following warning.Quoted 1 line
Quoted 1 line
warning: unresolved link to
kernel::drm::Device-->
rust/kernel/device.rs:154:22
|
154 | /// [drm::Device]:kernel::drm::Device
| ^^^^^^^^^^^^^^^^^^^ no item nameddrmin modulekernel
|
= note:#[warn(rustdoc::broken_intra_doc_links)]on by default
Quoted 7 lines
Fix this by making the intra-doc link conditional on
CONFIG_DRMbeing enabled.Fixes d6e26c1ae4a6 ("device: rust: expand documentation for Device")Suggested-by Alice Ryhl <[email protected]>Reported-by kernel test robot <[email protected]>Signed-off-by Danilo Krummrich <[email protected]>
Quoted 12 lines · Danilo Krummrich
drm::Deviceis only available whenCONFIG_DRM=y, which we have to consider for intra-doc links, otherwise the rustdoc make target produces the following warning.Quoted 1 line
Quoted 1 line
warning: unresolved link to
kernel::drm::Device-->
rust/kernel/device.rs:154:22
|
154 | /// [drm::Device]:kernel::drm::Device
| ^^^^^^^^^^^^^^^^^^^ no item nameddrmin modulekernel
|
= note:#[warn(rustdoc::broken_intra_doc_links)]on by default
Quoted 7 lines
Fix this by making the intra-doc link conditional on
CONFIG_DRMbeing enabled.Fixes d6e26c1ae4a6 ("device: rust: expand documentation for Device")Suggested-by Alice Ryhl <[email protected]>Reported-by kernel test robot <[email protected]>Signed-off-by Danilo Krummrich <[email protected]>
Applied to driver-core-linus, thanks!