linux-kernel - Re: [PATCH 1/3] rust: task: remove redundant explicit 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] [thread-next>] [day] [month] [year] [list]

Message-Id: <CW3S1FL7JQ9K.3R5QL6NYCVBJ8@gmail.com>
Date:   Mon, 09 Oct 2023 10:48:19 +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 1/3] rust: task: remove redundant explicit link

> Starting with Rust 1.73.0, `rustdoc` detects redundant explicit
> links with its new lint `redundant_explicit_links` [1]:
>
>     error: redundant explicit link target
>       --> rust/kernel/task.rs:85:21
>        |
>     85 |     /// [`current`](crate::current) macro because it is safe.
>        |          ---------  ^^^^^^^^^^^^^^ explicit target is redundant
>        |          |
>        |          because label contains path that resolves to same destination
>        |
>        = note: when a link's destination is not specified,
>                the label is used to resolve intra-doc links
>        = note: `-D rustdoc::redundant-explicit-links` implied by `-D warnings`
>     help: remove explicit link target
>        |
>     85 |     /// [`current`] macro because it is safe.
>
> In order to avoid the warning in the compiler upgrade commit,
> make it an intra-doc link as the tool suggests.
>
> Link: https://github.com/rust-lang/rust/pull/113167 [1]
> Signed-off-by: Miguel Ojeda <ojeda@...nel.org>
> ---
Reviewed-by: Vincenzo Palazzo <vincenzopalazzodev@...il.com>