linux-kernel - Re: [PATCH] rust: rbtree: fix overindented list item

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: <Z6cEXXvAbbDa13j5@ohnotp>
Date: Sat, 8 Feb 2025 16:14:37 +0900
From: Yutaro Ohno <yutaro.ono.418@...il.com>
To: Miguel Ojeda <ojeda@...nel.org>
Cc: Alex Gaynor <alex.gaynor@...il.com>, 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@...nel.org>,
	Alice Ryhl <aliceryhl@...gle.com>, Trevor Gross <tmgross@...ch.edu>,
	Danilo Krummrich <dakr@...nel.org>, rust-for-linux@...r.kernel.org,
	linux-kernel@...r.kernel.org, patches@...ts.linux.dev,
	stable@...r.kernel.org
Subject: Re: [PATCH] rust: rbtree: fix overindented list item

On 02/07, Miguel Ojeda wrote:
> Starting with Rust 1.86.0 (to be released 2025-04-03), Clippy will have
> a new lint, `doc_overindented_list_items` [1], which catches cases of
> overindented list items.
> 
> The lint has been added by Yutaro Ohno, based on feedback from the kernel
> [2] on a patch that fixed a similar case -- commit 0c5928deada1 ("rust:
> block: fix formatting in GenDisk doc").
> 
> Clippy reports a single case in the kernel, apart from the one already
> fixed in the commit above:
> 
>     error: doc list item overindented
>         --> rust/kernel/rbtree.rs:1152:5
>          |
>     1152 | ///     null, it is a pointer to the root of the [`RBTree`].
>          |     ^^^^ help: try using `  ` (2 spaces)
>          |
>          = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_overindented_list_items
>          = note: `-D clippy::doc-overindented-list-items` implied by `-D warnings`
>          = help: to override `-D warnings` add `#[allow(clippy::doc_overindented_list_items)]`
> 
> Thus clean it up.
> 
> Cc: Yutaro Ohno <yutaro.ono.418@...il.com>
> Cc: <stable@...r.kernel.org> # Needed in 6.12.y and 6.13.y only (Rust is pinned in older LTSs).
> Fixes: a335e9591404 ("rust: rbtree: add `RBTree::entry`")
> Link: https://github.com/rust-lang/rust-clippy/pull/13711 [1]
> Link: https://github.com/rust-lang/rust-clippy/issues/13601 [2]
> Signed-off-by: Miguel Ojeda <ojeda@...nel.org>

Hi Miguel,
Nice to see this change so quickly.

Reviewed-by: Yutaro Ohno <yutaro.ono.418@...il.com>

Cheers,
Yutaro