linux-kernel - Re: [PATCH 1/6] rust: init: make doctests compilable/testable

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: <xXR-61xWAVXlzdw6FRPCd9oIO4sbjDfRC3hreooJx7zXYgA2C93c2PpTG60ewEK1arQydz_iz33115RW4baniEtrI8_fWwNrEj28La74SfI=@protonmail.com>
Date:   Fri, 16 Jun 2023 11:12:59 +0000
From:   Björn Roy Baron <bjorn3_gh@...tonmail.com>
To:     Miguel Ojeda <ojeda@...nel.org>
Cc:     David Gow <davidgow@...gle.com>,
        Brendan Higgins <brendan.higgins@...ux.dev>,
        Wedson Almeida Filho <wedsonaf@...il.com>,
        Alex Gaynor <alex.gaynor@...il.com>,
        Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>,
        Benno Lossin <benno.lossin@...ton.me>,
        Alice Ryhl <aliceryhl@...gle.com>,
        Andreas Hindborg <nmi@...aspace.dk>,
        Philip Li <philip.li@...el.com>, kunit-dev@...glegroups.com,
        linux-kselftest@...r.kernel.org, rust-for-linux@...r.kernel.org,
        linux-kernel@...r.kernel.org, patches@...ts.linux.dev
Subject: Re: [PATCH 1/6] rust: init: make doctests compilable/testable

------- Original Message -------
On Wednesday, June 14th, 2023 at 20:08, Miguel Ojeda <ojeda@...nel.org> wrote:

> Rust documentation tests are going to be build/run-tested
> with the KUnit integration added in a future patch, thus
> update them to make them compilable/testable so that we
> may start enforcing it.
> 
> Signed-off-by: Miguel Ojeda <ojeda@...nel.org>
> ---
>  rust/kernel/init.rs | 25 ++++++++++++++++---------
>  1 file changed, 16 insertions(+), 9 deletions(-)
> 
> diff --git a/rust/kernel/init.rs b/rust/kernel/init.rs
> index b4332a4ec1f4..1073515ed40e 100644
> --- a/rust/kernel/init.rs
> +++ b/rust/kernel/init.rs
> @@ -120,14 +120,23 @@
>  //!   `slot` gets called.
>  //!
>  //! ```rust
> -//! use kernel::{prelude::*, init};
> +//! # #![allow(unreachable_pub, clippy::disallowed_names)]
> +//! use kernel::{prelude::*, init, types::Opaque};
>  //! use core::{ptr::addr_of_mut, marker::PhantomPinned, pin::Pin};
>  //! # mod bindings {
> +//! #     #![allow(non_camel_case_types)]
>  //! #     pub struct foo;
>  //! #     pub unsafe fn init_foo(_ptr: *mut foo) {}
>  //! #     pub unsafe fn destroy_foo(_ptr: *mut foo) {}
>  //! #     pub unsafe fn enable_foo(_ptr: *mut foo, _flags: u32) -> i32 { 0 }
>  //! # }
> +//! # 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
> @@ -158,7 +167,7 @@
>  //!                 if err != 0 {
>  //!                     // Enabling has failed, first clean up the foo and then return the error.
>  //!                     bindings::destroy_foo(Opaque::raw_get(foo));
> -//!                     return Err(Error::from_kernel_errno(err));
> +//!                     return Err(Error::from_errno(err));
>  //!                 }
>  //!
>  //!                 // All fields of `RawFoo` have been initialized, since `_p` is a ZST.
> @@ -226,8 +235,7 @@
>  ///
>  /// ```rust
>  /// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)]
> -/// # use kernel::{init, pin_init, stack_pin_init, init::*, sync::Mutex, new_mutex};
> -/// # use macros::pin_data;
> +/// # use kernel::{init, macros::pin_data, pin_init, stack_pin_init, init::*, sync::Mutex, new_mutex};
>  /// # use core::pin::Pin;
>  /// #[pin_data]
>  /// struct Foo {
> @@ -277,7 +285,7 @@ macro_rules! stack_pin_init {
>  ///
>  /// # Examples
>  ///
> -/// ```rust
> +/// ```rust,ignore
>  /// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)]
>  /// # use kernel::{init, pin_init, stack_try_pin_init, init::*, sync::Mutex, new_mutex};
>  /// # use macros::pin_data;
> @@ -303,7 +311,7 @@ macro_rules! stack_pin_init {
>  /// pr_info!("a: {}", &*foo.a.lock());
>  /// ```
>  ///
> -/// ```rust
> +/// ```rust,ignore
>  /// # #![allow(clippy::disallowed_names, clippy::new_ret_no_self)]
>  /// # use kernel::{init, pin_init, stack_try_pin_init, init::*, sync::Mutex, new_mutex};
>  /// # use macros::pin_data;
> @@ -513,8 +521,7 @@ macro_rules! stack_try_pin_init {
>  /// For instance:
>  ///
>  /// ```rust
> -/// # use kernel::pin_init;
> -/// # use macros::pin_data;
> +/// # use kernel::{macros::pin_data, pin_init};
>  /// # use core::{ptr::addr_of_mut, marker::PhantomPinned};
>  /// #[pin_data]
>  /// struct Buf {
> @@ -841,7 +848,7 @@ macro_rules! init {
>  /// # Examples
>  ///
>  /// ```rust
> -/// use kernel::{init::PinInit, error::Error, InPlaceInit};
> +/// use kernel::{init::{PinInit, zeroed}, error::Error};
>  /// struct BigBuf {
>  ///     big: Box<[u8; 1024 * 1024 * 1024]>,
>  ///     small: [u8; 1024 * 1024],
> -- 
> 2.41.0

Reviewed-by: Björn Roy Baron <bjorn3_gh@...tonmail.com>