Commit e5d330e1 authored by Miguel Ojeda's avatar Miguel Ojeda
Browse files

rust: allow `clippy::disallowed_names` for doctests 

Examples (i.e. doctests) may want to use names such as `foo`, thus the
`clippy::disallowed_names` lint [1] gets in the way.

Thus allow it for all doctests.

In addition, remove it from the existing `expect`s we have in a few
doctests.

This does not mean that we should stop trying to find good names for
our examples, though.

Link: https://rust-lang.github.io/rust-clippy/stable/index.html#disallowed_names

 [1]
Suggested-by: default avatarAlice Ryhl <aliceryhl@google.com>
Link: https://lore.kernel.org/rust-for-linux/aRHSLChi5HYXW4-9@google.com/


Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Acked-by: default avatarBenno Lossin <lossin@kernel.org>
Link: https://patch.msgid.link/20251117080714.876978-1-ojeda@kernel.org


Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent ab844cf3

rust/kernel/init.rs

+1 −2
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ 
//! ## General Examples

//!

//! ```rust

//! # #![expect(clippy::disallowed_names, clippy::undocumented_unsafe_blocks)]

//! # #![expect(clippy::undocumented_unsafe_blocks)]

//! use kernel::types::Opaque;

//! use pin_init::pin_init_from_closure;

//!
@@ -67,7 +67,6 @@ 
//! ```

//!

//! ```rust

//! # #![expect(clippy::disallowed_names)]

//! use kernel::{prelude::*, types::Opaque};

//! use core::{ptr::addr_of_mut, marker::PhantomPinned, pin::Pin};

//! # mod bindings {

rust/kernel/types.rs

+0 −1
Original line number Diff line number Diff line
@@ -289,7 +289,6 @@ fn drop(&mut self) { 
/// # Examples

///

/// ```

/// # #![expect(clippy::disallowed_names)]

/// use kernel::types::Opaque;

/// # // Emulate a C struct binding which is from C, maybe uninitialized or not, only the C side

/// # // knows.

scripts/rustdoc_test_gen.rs

+1 −1
Original line number Diff line number Diff line
@@ -208,7 +208,7 @@ macro_rules! assert_eq {{ 
    #[allow(unused)]

    static __DOCTEST_ANCHOR: i32 = ::core::line!() as i32 + {body_offset} + 1;

    {{

        #![allow(unreachable_pub)]

        #![allow(unreachable_pub, clippy::disallowed_names)]

        {body}

        main();

    }}