]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
rust: device: fix broken intra-doc links
authorFUJITA Tomonori <fujita.tomonori@gmail.com>
Wed, 31 Dec 2025 04:57:28 +0000 (13:57 +0900)
committerDanilo Krummrich <dakr@kernel.org>
Fri, 2 Jan 2026 18:05:04 +0000 (19:05 +0100)
commita9a42f0754b6c69525612d678b73da790e28b9fd
tree1849b73d382051d191a7c7d3653dfddaec493304
parent32cb3840386fd3684fbe8294cfc0a6684417139e
rust: device: fix broken intra-doc links

The `pci` module is conditional on CONFIG_PCI. When it's disabled, the
intra-doc link to `pci::Device` causes rustdoc warnings:

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

Fix this by making the documentation conditional on CONFIG_PCI.

Fixes: d6e26c1ae4a6 ("device: rust: expand documentation for Device")
Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
Reviewed-by: Dirk Behme <dirk.behme@de.bosch.com>
Link: https://patch.msgid.link/20251231045728.1912024-2-fujita.tomonori@gmail.com
[ Keep the "such as" part indicating a list of examples; fix typos in
  commit message. - Danilo ]
Signed-off-by: Danilo Krummrich <dakr@kernel.org>
rust/kernel/device.rs