linux-kernel - Re: [PATCH 2/3] rust: print: use explicit link in documentation

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] [thread-next>] [day] [month] [year] [list]

Message-Id: <CW3S1RNMMQKE.3DP29TLAE53AD@gmail.com>
Date:   Mon, 09 Oct 2023 10:48:45 +0200
From:   "Vincenzo Palazzo" <vincenzopalazzodev@...il.com>
To:     "Miguel Ojeda" <ojeda@...nel.org>,
        "Wedson Almeida Filho" <wedsonaf@...il.com>,
        "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>,
        "Benno Lossin" <benno.lossin@...ton.me>,
        "Andreas Hindborg" <a.hindborg@...sung.com>,
        "Alice Ryhl" <aliceryhl@...gle.com>,
        <rust-for-linux@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        <patches@...ts.linux.dev>
Subject: Re: [PATCH 2/3] rust: print: use explicit link in documentation

> The future `rustdoc` in the Rust 1.73.0 upgrade requires an explicit
> link for `pr_info!`:
>
>     error: unresolved link to `pr_info`
>        --> rust/kernel/print.rs:395:63
>         |
>     395 | /// Use only when continuing a previous `pr_*!` macro (e.g. [`pr_info!`]).
>         |                                                               ^^^^^^^^ no item named `pr_info` in scope
>         |
>         = note: `macro_rules` named `pr_info` exists in this crate, but it is not in scope at this link's location
>         = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
>
> Thus do so to avoid a broken link while upgrading.
>
> Signed-off-by: Miguel Ojeda <ojeda@...nel.org>
> ---
Reviewed-by: Vincenzo Palazzo <vincenzopalazzodev@...il.com>