Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Fri, 16 Jun 2023 11:14:56 +0000
To:     Miguel Ojeda <ojeda@kernel.org>
From:   =?utf-8?Q?Bj=C3=B6rn_Roy_Baron?= <bjorn3_gh@protonmail.com>
Cc:     David Gow <davidgow@google.com>,
        Brendan Higgins <brendan.higgins@linux.dev>,
        Wedson Almeida Filho <wedsonaf@gmail.com>,
        Alex Gaynor <alex.gaynor@gmail.com>,
        Boqun Feng <boqun.feng@gmail.com>, Gary Guo <gary@garyguo.net>,
        Benno Lossin <benno.lossin@proton.me>,
        Alice Ryhl <aliceryhl@google.com>,
        Andreas Hindborg <nmi@metaspace.dk>,
        Philip Li <philip.li@intel.com>, kunit-dev@googlegroups.com,
        linux-kselftest@vger.kernel.org, rust-for-linux@vger.kernel.org,
        linux-kernel@vger.kernel.org, patches@lists.linux.dev
Subject: Re: [PATCH 4/6] rust: types: make doctests compilable/testable
Message-ID: <8G95KEldmnhs6iOWt4K2Qpb6_TNvLTj36k5DT1ydKnJqcmp4FY44KP6rr8aqNGZE3EirT8v2Ak14r5keNM8kf-BBC8Yobi6W2eLaiu1AFq4=@protonmail.com>
In-Reply-To: <20230614180837.630180-5-ojeda@kernel.org>
References: <20230614180837.630180-1-ojeda@kernel.org> <20230614180837.630180-5-ojeda@kernel.org>
Feedback-ID: 27884398:user:proton
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

------- Original Message -------
On Wednesday, June 14th, 2023 at 20:08, Miguel Ojeda <ojeda@kernel.org> wro=
te:

> 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.
>=20
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
>  rust/kernel/types.rs | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>=20
> diff --git a/rust/kernel/types.rs b/rust/kernel/types.rs
> index 1e5380b16ed5..696d6c5a3b9d 100644
> --- a/rust/kernel/types.rs
> +++ b/rust/kernel/types.rs
> @@ -109,7 +109,7 @@ unsafe fn from_foreign(_: *const core::ffi::c_void) -=
> Self {}
>  /// In the example below, we have multiple exit paths and we want to log=
 regardless of which one is
>  /// taken:
>  /// ```
> -/// # use kernel::ScopeGuard;
> +/// # use kernel::types::ScopeGuard;
>  /// fn example1(arg: bool) {
>  ///     let _log =3D ScopeGuard::new(|| pr_info!("example1 completed\n")=
);
>  ///
> @@ -127,7 +127,7 @@ unsafe fn from_foreign(_: *const core::ffi::c_void) -=
> Self {}
>  /// In the example below, we want to log the same message on all early e=
xits but a different one on
>  /// the main exit path:
>  /// ```
> -/// # use kernel::ScopeGuard;
> +/// # use kernel::types::ScopeGuard;
>  /// fn example2(arg: bool) {
>  ///     let log =3D ScopeGuard::new(|| pr_info!("example2 returned early=
\n"));
>  ///
> @@ -148,7 +148,7 @@ unsafe fn from_foreign(_: *const core::ffi::c_void) -=
> Self {}
>  /// In the example below, we need a mutable object (the vector) to be ac=
cessible within the log
>  /// function, so we wrap it in the [`ScopeGuard`]:
>  /// ```
> -/// # use kernel::ScopeGuard;
> +/// # use kernel::types::ScopeGuard;
>  /// fn example3(arg: bool) -> Result {
>  ///     let mut vec =3D
>  ///         ScopeGuard::new_with_data(Vec::new(), |v| pr_info!("vec had =
{} elements\n", v.len()));
> --=20
> 2.41.0

Reviewed-by: Bj=C3=B6rn Roy Baron <bjorn3_gh@protonmail.com>