[6.12.y,14/60] rust: enable Clippy's `check-private-items`

Message ID	20250307225008.779961-15-ojeda@kernel.org
State	New
Headers	show Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DE3A418BC36; Fri, 7 Mar 2025 22:51:14 +0000 (UTC) From: Miguel Ojeda <ojeda@kernel.org> To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>, Sasha Levin <sashal@kernel.org>, stable@vger.kernel.org Cc: Danilo Krummrich <dakr@kernel.org>, Alice Ryhl <aliceryhl@google.com>, Alyssa Ross <hi@alyssa.is>, NoisyCoil <noisycoil@disroot.org>, patches@lists.linux.dev, Miguel Ojeda <ojeda@kernel.org> Subject: [PATCH 6.12.y 14/60] rust: enable Clippy's `check-private-items` Date: Fri, 7 Mar 2025 23:49:21 +0100 Message-ID: <20250307225008.779961-15-ojeda@kernel.org> In-Reply-To: <20250307225008.779961-1-ojeda@kernel.org> References: <20250307225008.779961-1-ojeda@kernel.org> Precedence: bulk MIME-Version: 1.0 Content-Transfer-Encoding: 8bit
Series	`alloc`, `#[expect]` and "Custom FFI" \| expand [6.12.y,00/60] `alloc`, `#[expect]` and "Custom FFI" [6.12.y,01/60] rust: workqueue: remove unneeded ``#[allow(clippy::new_ret_no_self)]` [6.12.y,02/60] rust: sort global Rust flags [6.12.y,03/60] rust: types: avoid repetition in `{As,From}Bytes` impls [6.12.y,04/60] rust: enable `clippy::undocumented_unsafe_blocks` lint [6.12.y,05/60] rust: enable `clippy::unnecessary_safety_comment` lint [6.12.y,06/60] rust: enable `clippy::unnecessary_safety_doc` lint [6.12.y,07/60] rust: enable `clippy::ignored_unit_patterns` lint [6.12.y,08/60] rust: enable `rustdoc::unescaped_backticks` lint [6.12.y,09/60] rust: init: remove unneeded `#[allow(clippy::disallowed_names)]` [6.12.y,10/60] rust: sync: remove unneeded `#[allow(clippy::non_send_fields_in_send_ty)]` [6.12.y,11/60] rust: introduce `.clippy.toml` [6.12.y,12/60] rust: replace `clippy::dbg_macro` with `disallowed_macros` [6.12.y,13/60] rust: provide proper code documentation titles [6.12.y,14/60] rust: enable Clippy's `check-private-items` [6.12.y,15/60] Documentation: rust: add coding guidelines on lints [6.12.y,16/60] rust: start using the `#[expect(...)]` attribute [6.12.y,17/60] Documentation: rust: discuss `#[expect(...)]` in the guidelines [6.12.y,18/60] rust: error: make conversion functions public [6.12.y,19/60] rust: error: optimize error type to use nonzero [6.12.y,20/60] rust: alloc: add `Allocator` trait [6.12.y,21/60] rust: alloc: separate `aligned_size` from `krealloc_aligned` [6.12.y,22/60] rust: alloc: rename `KernelAllocator` to `Kmalloc` [6.12.y,23/60] rust: alloc: implement `ReallocFunc` [6.12.y,24/60] rust: alloc: make `allocator` module public [6.12.y,25/60] rust: alloc: implement `Allocator` for `Kmalloc` [6.12.y,26/60] rust: alloc: add module `allocator_test` [6.12.y,27/60] rust: alloc: implement `Vmalloc` allocator [6.12.y,28/60] rust: alloc: implement `KVmalloc` allocator [6.12.y,29/60] rust: alloc: add __GFP_NOWARN to `Flags` [6.12.y,30/60] rust: alloc: implement kernel `Box` [6.12.y,31/60] rust: treewide: switch to our kernel `Box` type [6.12.y,32/60] rust: alloc: remove extension of std's `Box` [6.12.y,33/60] rust: alloc: add `Box` to prelude [6.12.y,34/60] rust: alloc: introduce `ArrayLayout` [6.12.y,35/60] rust: alloc: implement kernel `Vec` type [6.12.y,36/60] rust: alloc: implement `IntoIterator` for `Vec` [6.12.y,37/60] rust: alloc: implement `collect` for `IntoIter` [6.12.y,38/60] rust: treewide: switch to the kernel `Vec` type [6.12.y,39/60] rust: alloc: remove `VecExt` extension [6.12.y,40/60] rust: alloc: add `Vec` to prelude [6.12.y,41/60] rust: error: use `core::alloc::LayoutError` [6.12.y,42/60] rust: error: check for config `test` in `Error::name` [6.12.y,43/60] rust: alloc: implement `contains` for `Flags` [6.12.y,44/60] rust: alloc: implement `Cmalloc` in module allocator_test [6.12.y,45/60] rust: str: test: replace `alloc::format` [6.12.y,46/60] rust: alloc: update module comment of alloc.rs [6.12.y,47/60] kbuild: rust: remove the `alloc` crate and `GlobalAlloc` [6.12.y,48/60] MAINTAINERS: add entry for the Rust `alloc` module [6.12.y,49/60] drm/panic: avoid reimplementing Iterator::find [6.12.y,50/60] drm/panic: remove unnecessary borrow in alignment_pattern [6.12.y,51/60] drm/panic: prefer eliding lifetimes [6.12.y,52/60] drm/panic: remove redundant field when assigning value [6.12.y,53/60] drm/panic: correctly indent continuation of line in list item [6.12.y,54/60] drm/panic: allow verbose boolean for clarity [6.12.y,55/60] drm/panic: allow verbose version check [6.12.y,56/60] rust: kbuild: expand rusttest target for macros [6.12.y,57/60] rust: fix size_t in bindgen prototypes of C builtins [6.12.y,58/60] rust: map `__kernel_size_t` and friends also to usize/isize [6.12.y,59/60] rust: use custom FFI integer types [6.12.y,60/60] rust: alloc: Fix `ArrayLayout` allocations

Message ID

20250307225008.779961-15-ojeda@kernel.org

State

New

Headers

From: Miguel Ojeda <ojeda@kernel.org>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Sasha Levin <sashal@kernel.org>,
	stable@vger.kernel.org
Cc: Danilo Krummrich <dakr@kernel.org>,
	Alice Ryhl <aliceryhl@google.com>,
	Alyssa Ross <hi@alyssa.is>,
	NoisyCoil <noisycoil@disroot.org>,
	patches@lists.linux.dev,
	Miguel Ojeda <ojeda@kernel.org>
Subject: [PATCH 6.12.y 14/60] rust: enable Clippy's `check-private-items`
Date: Fri,  7 Mar 2025 23:49:21 +0100
Message-ID: <20250307225008.779961-15-ojeda@kernel.org>
In-Reply-To: <20250307225008.779961-1-ojeda@kernel.org>
References: <20250307225008.779961-1-ojeda@kernel.org>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

Series

`alloc`, `#[expect]` and "Custom FFI" | expand

Commit Message

Miguel Ojeda March 7, 2025, 10:49 p.m. UTC

commit 624063b9ac97f40cadca32a896aafeb28b1220fd upstream.

In Rust 1.76.0, Clippy added the `check-private-items` lint configuration
option. When turned on (the default is off), it makes several lints
check private items as well.

In our case, it affects two lints we have enabled [1]:
`missing_safety_doc` and `unnecessary_safety_doc`.

It also seems to affect the new `too_long_first_doc_paragraph` lint [2],
even though the documentation does not mention it.

Thus allow the few instances remaining we currently hit and enable
the lint.

Link: https://doc.rust-lang.org/nightly/clippy/lint_configuration.html#check-private-items [1]
Link: https://rust-lang.github.io/rust-clippy/master/index.html#/too_long_first_doc_paragraph [2]
Reviewed-by: Trevor Gross <tmgross@umich.edu>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Tested-by: Gary Guo <gary@garyguo.net>
Reviewed-by: Gary Guo <gary@garyguo.net>
Link: https://lore.kernel.org/r/20240904204347.168520-16-ojeda@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 .clippy.toml                   | 2 ++
 rust/kernel/init.rs            | 1 +
 rust/kernel/init/__internal.rs | 2 ++
 rust/kernel/init/macros.rs     | 1 +
 rust/kernel/print.rs           | 1 +
 5 files changed, 7 insertions(+)

diff --git a/.clippy.toml b/.clippy.toml
index ad9f804fb677..e4c4eef10b28 100644
--- a/.clippy.toml
+++ b/.clippy.toml
@@ -1,5 +1,7 @@ 
 # SPDX-License-Identifier: GPL-2.0
 
+check-private-items = true
+
 disallowed-macros = [
     # The `clippy::dbg_macro` lint only works with `std::dbg!`, thus we simulate
     # it here, see: https://github.com/rust-lang/rust-clippy/issues/11303.
diff --git a/rust/kernel/init.rs b/rust/kernel/init.rs
index 0330a8756fa5..fdbf0857ba20 100644
--- a/rust/kernel/init.rs
+++ b/rust/kernel/init.rs
@@ -125,6 +125,7 @@ 
 //! use core::{ptr::addr_of_mut, marker::PhantomPinned, pin::Pin};
 //! # mod bindings {
 //! #     #![allow(non_camel_case_types)]
+//! #     #![allow(clippy::missing_safety_doc)]
 //! #     pub struct foo;
 //! #     pub unsafe fn init_foo(_ptr: *mut foo) {}
 //! #     pub unsafe fn destroy_foo(_ptr: *mut foo) {}
diff --git a/rust/kernel/init/__internal.rs b/rust/kernel/init/__internal.rs
index 163eb072f296..549ae227c2ea 100644
--- a/rust/kernel/init/__internal.rs
+++ b/rust/kernel/init/__internal.rs
@@ -54,6 +54,7 @@  unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), E> {
 pub unsafe trait HasPinData {
     type PinData: PinData;
 
+    #[allow(clippy::missing_safety_doc)]
     unsafe fn __pin_data() -> Self::PinData;
 }
 
@@ -83,6 +84,7 @@  fn make_closure<F, O, E>(self, f: F) -> F
 pub unsafe trait HasInitData {
     type InitData: InitData;
 
+    #[allow(clippy::missing_safety_doc)]
     unsafe fn __init_data() -> Self::InitData;
 }
 
diff --git a/rust/kernel/init/macros.rs b/rust/kernel/init/macros.rs
index 736fe0ce0cd9..193d39886b1f 100644
--- a/rust/kernel/init/macros.rs
+++ b/rust/kernel/init/macros.rs
@@ -989,6 +989,7 @@  fn drop(&mut self) {
         //
         // The functions are `unsafe` to prevent accidentally calling them.
         #[allow(dead_code)]
+        #[allow(clippy::missing_safety_doc)]
         impl<$($impl_generics)*> $pin_data<$($ty_generics)*>
         where $($whr)*
         {
diff --git a/rust/kernel/print.rs b/rust/kernel/print.rs
index fe53fc469c4f..45af17095a24 100644
--- a/rust/kernel/print.rs
+++ b/rust/kernel/print.rs
@@ -14,6 +14,7 @@ 
 use crate::str::RawFormatter;
 
 // Called from `vsprintf` with format specifier `%pA`.
+#[allow(clippy::missing_safety_doc)]
 #[no_mangle]
 unsafe extern "C" fn rust_fmt_argument(
     buf: *mut c_char,

[6.12.y,14/60] rust: enable Clippy's `check-private-items`

Commit Message

Patch