rust: init: re-enable doctests
Subsystems (2)
Miguel Ojeda
maintainerPATCH 1/2 rust: init: re-enable doctests
Commit a30e94c29673 ("rust: init: make doctests compilable/testable") made these tests buildable among others, but eventually the pin-init crate was made into its own crate [1] and the tests were marked as ignore in commit 206dea39e559 ("rust: init: disable doctests").
A few other bits got changed in that reorganization, e.g. the clippy::missing_safety_doc was removed and the expect use.
Since there is no reason not to build/test them, re-enable them.
In order to do so, tweak a few bits to keep the build clean, and also use again expect since this is one of those places where we can actually do so.
--- rust/kernel/init.rs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
rust/kernel/init.rs +6 -6
@@ -29,15 +29,15 @@//! //! ## General Examples //! -//! ```rust,ignore -//! # #![allow(clippy::disallowed_names)] +//! ```rust +//! # #![expect(clippy::disallowed_names, clippy::undocumented_unsafe_blocks)] //! use kernel::types::Opaque; //! use pin_init::pin_init_from_closure; //! //! // assume we have some `raw_foo` type in C: //! #[repr(C)] //! struct RawFoo([u8; 16]); -//! extern { +//! extern "C" { //! fn init_foo(_: *mut RawFoo); //! } //!
@@ -66,12 +66,12 @@//! }); //! ``` //! -//! ```rust,ignore -//! # #![allow(unreachable_pub, clippy::disallowed_names)] +//! ```rust +//! # #![expect(unreachable_pub, clippy::disallowed_names)] //! use kernel::{prelude::*, types::Opaque}; //! use core::{ptr::addr_of_mut, marker::PhantomPinned, pin::Pin}; //! # mod bindings { -//! # #![allow(non_camel_case_types)] +//! # #![expect(non_camel_case_types, clippy::missing_safety_doc)] //! # pub struct foo; //! # pub unsafe fn init_foo(_ptr: *mut foo) {} //! # pub unsafe fn destroy_foo(_ptr: *mut foo) {}
base-commit: f4daa80d6be7d3c55ca72a8e560afc4e21f886aa
Signature · 1 line
2.49.0
Miguel Ojeda
maintainerPATCH 2/2 rust: init: remove doctest's `Error::from_errno` workaround
Since commit 5ed147473458 ("rust: error: make conversion functions public"), Error::from_errno is public.
Thus remove the workaround added in commit a30e94c29673 ("rust: init:
make doctests compilable/testable").
--- rust/kernel/init.rs | 8 -------- 1 file changed, 8 deletions(-)
rust/kernel/init.rs +0 -8
@@ -77,14 +77,6 @@//! # pub unsafe fn destroy_foo(_ptr: *mut foo) {} //! # pub unsafe fn enable_foo(_ptr: *mut foo, _flags: u32) -> i32 { 0 } //! # } -//! # // `Error::from_errno` is `pub(crate)` in the `kernel` crate, thus provide a workaround. -//! # trait FromErrno { -//! # fn from_errno(errno: core::ffi::c_int) -> Error { -//! # // Dummy error that can be constructed outside the `kernel` crate. -//! # Error::from(core::fmt::Error) -//! # } -//! # } -//! # impl FromErrno for Error {} //! /// # Invariants //! /// //! /// `foo` is always initialized
Signature · 1 line
2.49.0
Quoted 14 lines · Miguel Ojeda
Commit
a30e94c29673("rust: init: make doctests compilable/testable") made these tests buildable among others, but eventually the pin-init crate was made into its own crate [1] and the tests were marked asignorein commit206dea39e559("rust: init: disable doctests").A few other bits got changed in that reorganization, e.g. the
clippy::missing_safety_docwas removed and theexpectuse.Since there is no reason not to build/test them, re-enable them.
In order to do so, tweak a few bits to keep the build clean, and also use again
expectsince this is one of those places where we can actually do so.
Quoted 5 lines
Signed-off-by Miguel Ojeda <[email protected]>--- rust/kernel/init.rs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
Applied both to pin-init-next -- thanks everyone!
---
Cheers,
Benno