linux-kernel - Re: [PATCH] rust: faux: fix C header link

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-Id: <DBTWT3AYHLLR.2NC0F6MRMZPCY@kernel.org>
Date: Mon, 04 Aug 2025 22:01:26 +0200
From: "Benno Lossin" <lossin@...nel.org>
To: "Miguel Ojeda" <ojeda@...nel.org>, "Greg Kroah-Hartman"
 <gregkh@...uxfoundation.org>, "Rafael J. Wysocki" <rafael@...nel.org>,
 "Danilo Krummrich" <dakr@...nel.org>, "Alex Gaynor" <alex.gaynor@...il.com>
Cc: "Boqun Feng" <boqun.feng@...il.com>, "Gary Guo" <gary@...yguo.net>,
 Björn Roy Baron <bjorn3_gh@...tonmail.com>, "Andreas
 Hindborg" <a.hindborg@...nel.org>, "Alice Ryhl" <aliceryhl@...gle.com>,
 "Trevor Gross" <tmgross@...ch.edu>, <rust-for-linux@...r.kernel.org>,
 <linux-kernel@...r.kernel.org>, <patches@...ts.linux.dev>,
 <stable@...r.kernel.org>
Subject: Re: [PATCH] rust: faux: fix C header link

On Mon Aug 4, 2025 at 7:13 PM CEST, Miguel Ojeda wrote:
> Starting with Rust 1.91.0 (expected 2025-10-30), `rustdoc` has improved
> some false negatives around intra-doc links [1], and it found a broken
> intra-doc link we currently have:
>
>     error: unresolved link to `include/linux/device/faux.h`
>      --> rust/kernel/faux.rs:7:17
>       |
>     7 | //! C header: [`include/linux/device/faux.h`]
>       |                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `include/linux/device/faux.h` in scope
>       |
>       = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
>       = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
>       = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`
>
> Our `srctree/` C header links are not intra-doc links, thus they need
> the link destination.
>
> Thus fix it.
>
> Cc: stable@...r.kernel.org
> Link: https://github.com/rust-lang/rust/pull/132748 [1]
> Fixes: 78418f300d39 ("rust/kernel: Add faux device bindings")
> Signed-off-by: Miguel Ojeda <ojeda@...nel.org>

Reviewed-by: Benno Lossin <lossin@...nel.org>

---
Cheers,
Benno

> ---
> It may have been in 1.90, but the beta branch does not have it, and the
> rollup PR says 1.91, unlike the PR itself, so I picked 1.91. It happened
> just after the version bump to 1.91, so it may have to do with that.
>
>  rust/kernel/faux.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)