linux-kernel - Re: [PATCH 3/6] rust: sync: 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: <BlurLQzIVAVc1TilZfkOwtHd_jenh64E_Zb4sXczlga-q3uYqfyafFEhXuk4GEbUoxToZKDgXssuvFSOWCwxSsKIS0Q5G-9sr_ADs6wdCEM=@protonmail.com>
Date:   Fri, 16 Jun 2023 11:14:04 +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 3/6] rust: sync: 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/sync/arc.rs           | 9 +++++++--
>  rust/kernel/sync/lock/mutex.rs    | 1 +
>  rust/kernel/sync/lock/spinlock.rs | 1 +
>  3 files changed, 9 insertions(+), 2 deletions(-)
> 
> diff --git a/rust/kernel/sync/arc.rs b/rust/kernel/sync/arc.rs
> index a89843cacaad..1ecb2efab51e 100644
> --- a/rust/kernel/sync/arc.rs
> +++ b/rust/kernel/sync/arc.rs
> @@ -73,6 +73,7 @@
>  /// assert_eq!(cloned.b, 20);
>  ///
>  /// // The refcount drops to zero when `cloned` goes out of scope, and the memory is freed.
> +/// # Ok::<(), Error>(())
>  /// ```
>  ///
>  /// Using `Arc<T>` as the type of `self`:
> @@ -98,6 +99,7 @@
>  /// let obj = Arc::try_new(Example { a: 10, b: 20 })?;
>  /// obj.use_reference();
>  /// obj.take_over();
> +/// # Ok::<(), Error>(())
>  /// ```
>  ///
>  /// Coercion from `Arc<Example>` to `Arc<dyn MyTrait>`:
> @@ -121,6 +123,7 @@
>  ///
>  /// // `coerced` has type `Arc<dyn MyTrait>`.
>  /// let coerced: Arc<dyn MyTrait> = obj;
> +/// # Ok::<(), Error>(())
>  /// ```
>  pub struct Arc<T: ?Sized> {
>      ptr: NonNull<ArcInner<T>>,
> @@ -337,7 +340,7 @@ fn from(item: Pin<UniqueArc<T>>) -> Self {
>  /// # Example
>  ///
>  /// ```
> -/// use crate::sync::{Arc, ArcBorrow};
> +/// use kernel::sync::{Arc, ArcBorrow};
>  ///
>  /// struct Example;
>  ///
> @@ -350,12 +353,13 @@ fn from(item: Pin<UniqueArc<T>>) -> Self {
>  ///
>  /// // Assert that both `obj` and `cloned` point to the same underlying object.
>  /// assert!(core::ptr::eq(&*obj, &*cloned));
> +/// # Ok::<(), Error>(())
>  /// ```
>  ///
>  /// Using `ArcBorrow<T>` as the type of `self`:
>  ///
>  /// ```
> -/// use crate::sync::{Arc, ArcBorrow};
> +/// use kernel::sync::{Arc, ArcBorrow};
>  ///
>  /// struct Example {
>  ///     a: u32,
> @@ -370,6 +374,7 @@ fn from(item: Pin<UniqueArc<T>>) -> Self {
>  ///
>  /// let obj = Arc::try_new(Example { a: 10, b: 20 })?;
>  /// obj.as_arc_borrow().use_reference();
> +/// # Ok::<(), Error>(())
>  /// ```
>  pub struct ArcBorrow<'a, T: ?Sized + 'a> {
>      inner: NonNull<ArcInner<T>>,
> diff --git a/rust/kernel/sync/lock/mutex.rs b/rust/kernel/sync/lock/mutex.rs
> index 923472f04af4..09276fedc091 100644
> --- a/rust/kernel/sync/lock/mutex.rs
> +++ b/rust/kernel/sync/lock/mutex.rs
> @@ -63,6 +63,7 @@ macro_rules! new_mutex {
>  /// assert_eq!(e.c, 10);
>  /// assert_eq!(e.d.lock().a, 20);
>  /// assert_eq!(e.d.lock().b, 30);
> +/// # Ok::<(), Error>(())
>  /// ```
>  ///
>  /// The following example shows how to use interior mutability to modify the contents of a struct
> diff --git a/rust/kernel/sync/lock/spinlock.rs b/rust/kernel/sync/lock/spinlock.rs
> index 979b56464a4e..91eb2c9e9123 100644
> --- a/rust/kernel/sync/lock/spinlock.rs
> +++ b/rust/kernel/sync/lock/spinlock.rs
> @@ -61,6 +61,7 @@ macro_rules! new_spinlock {
>  /// assert_eq!(e.c, 10);
>  /// assert_eq!(e.d.lock().a, 20);
>  /// assert_eq!(e.d.lock().b, 30);
> +/// # Ok::<(), Error>(())
>  /// ```
>  ///
>  /// The following example shows how to use interior mutability to modify the contents of a struct
> -- 
> 2.41.0

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