linux-kernel - Re: [PATCH] rust: driver: fix broken intra-doc links to example driver types

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <DFBWP6JS4FWC.1KNF1QYIX5VRQ@kernel.org>
Date: Tue, 30 Dec 2025 23:32:14 +0100
From: "Danilo Krummrich" <dakr@...nel.org>
To: "Alice Ryhl" <aliceryhl@...gle.com>
Cc: "Greg Kroah-Hartman" <gregkh@...uxfoundation.org>, "Rafael J. Wysocki"
 <rafael@...nel.org>, "Miguel Ojeda" <ojeda@...nel.org>, "Boqun Feng"
 <boqun.feng@...il.com>, "Gary Guo" <gary@...yguo.net>,
 Björn Roy Baron <bjorn3_gh@...tonmail.com>, "Benno Lossin"
 <lossin@...nel.org>, "Andreas Hindborg" <a.hindborg@...nel.org>, "Trevor
 Gross" <tmgross@...ch.edu>, "Daniel Almeida"
 <daniel.almeida@...labora.com>, "Alexandre Courbot" <acourbot@...dia.com>,
 <rust-for-linux@...r.kernel.org>, <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] rust: driver: fix broken intra-doc links to example
 driver types

On Sat Dec 27, 2025 at 4:47 PM CET, Alice Ryhl wrote:
> The `auxiliary` and `pci` modules are conditional on
> `CONFIG_AUXILIARY_BUS` and `CONFIG_PCI` respectively. When these are
> disabled, the intra-doc links to `auxiliary::Driver` and `pci::Driver`
> break, causing rustdoc warnings (or errors with `-D warnings`).
>
> error: unresolved link to `kernel::auxiliary::Driver`
>   --> rust/kernel/driver.rs:82:28
>    |
> 82 | //! [`auxiliary::Driver`]: kernel::auxiliary::Driver
>    |                            ^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `auxiliary` in module `kernel`
>
> Fix this by making the documentation for these examples conditional on
> the corresponding configuration options.
>
> Fixes: 970a7c68788e ("driver: rust: expand documentation for driver infrastructure")
> Signed-off-by: Alice Ryhl <aliceryhl@...gle.com>

Applied to driver-core-linus, thanks!