From: Miguel Ojeda <ojeda@kernel.org>
To: David Gow <davidgow@google.com>,
Brendan Higgins <brendan.higgins@linux.dev>,
Miguel Ojeda <ojeda@kernel.org>,
Wedson Almeida Filho <wedsonaf@gmail.com>,
Alex Gaynor <alex.gaynor@gmail.com>
Cc: "Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"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: [PATCH 4/6] rust: types: make doctests compilable/testable
Date: Wed, 14 Jun 2023 20:08:28 +0200 [thread overview]
Message-ID: <20230614180837.630180-5-ojeda@kernel.org> (raw)
In-Reply-To: <20230614180837.630180-1-ojeda@kernel.org>
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@kernel.org>
---
rust/kernel/types.rs | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
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 = 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 exits but a different one on
/// the main exit path:
/// ```
-/// # use kernel::ScopeGuard;
+/// # use kernel::types::ScopeGuard;
/// fn example2(arg: bool) {
/// let log = 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 accessible 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 =
/// ScopeGuard::new_with_data(Vec::new(), |v| pr_info!("vec had {} elements\n", v.len()));
--
2.41.0
next prev parent reply other threads:[~2023-06-14 18:11 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-14 18:08 [PATCH 0/6] KUnit integration for Rust doctests Miguel Ojeda
2023-06-14 18:08 ` [PATCH 1/6] rust: init: make doctests compilable/testable Miguel Ojeda
2023-06-14 20:32 ` Alice Ryhl
2023-06-15 1:03 ` Martin Rodriguez Reboredo
2023-06-15 9:31 ` Miguel Ojeda
2023-06-15 13:33 ` Martin Rodriguez Reboredo
2023-06-15 23:47 ` Vincenzo Palazzo
2023-06-16 4:51 ` David Gow
2023-06-16 11:12 ` Björn Roy Baron
2023-06-25 10:13 ` Benno Lossin
2023-06-14 18:08 ` [PATCH 2/6] rust: str: " Miguel Ojeda
2023-06-14 20:32 ` Alice Ryhl
2023-06-15 1:04 ` Martin Rodriguez Reboredo
2023-06-15 23:47 ` Vincenzo Palazzo
2023-06-16 4:51 ` David Gow
2023-06-16 11:13 ` Björn Roy Baron
2023-06-14 18:08 ` [PATCH 3/6] rust: sync: " Miguel Ojeda
2023-06-14 20:32 ` Alice Ryhl
2023-06-15 1:04 ` Martin Rodriguez Reboredo
2023-06-16 4:51 ` David Gow
2023-06-16 11:14 ` Björn Roy Baron
2023-06-14 18:08 ` Miguel Ojeda [this message]
2023-06-14 20:32 ` [PATCH 4/6] rust: types: " Alice Ryhl
2023-06-15 1:06 ` Martin Rodriguez Reboredo
2023-06-16 4:52 ` David Gow
2023-06-16 11:14 ` Björn Roy Baron
2023-06-14 18:08 ` [PATCH 5/6] rust: support running Rust documentation tests as KUnit ones Miguel Ojeda
2023-06-14 20:38 ` Alice Ryhl
2023-06-14 22:09 ` Miguel Ojeda
2023-06-14 22:09 ` Miguel Ojeda
2023-06-15 0:19 ` Matt Gilbride
2023-06-15 3:49 ` Martin Rodriguez Reboredo
2023-06-15 9:23 ` Miguel Ojeda
2023-06-15 13:50 ` Martin Rodriguez Reboredo
2023-06-15 23:53 ` Vincenzo Palazzo
2023-06-16 4:52 ` David Gow
2023-06-19 17:16 ` Sergio González Collado
2023-06-30 18:17 ` Boqun Feng
2023-06-14 18:08 ` [PATCH 6/6] MAINTAINERS: add Rust KUnit files to the KUnit entry Miguel Ojeda
2023-06-15 3:49 ` Martin Rodriguez Reboredo
2023-06-15 23:46 ` Vincenzo Palazzo
2023-06-16 4:53 ` David Gow
2023-06-15 1:44 ` [PATCH 0/6] KUnit integration for Rust doctests Boqun Feng
2023-06-15 8:20 ` Miguel Ojeda
2023-06-16 4:44 ` David Gow
2023-06-16 4:51 ` David Gow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230614180837.630180-5-ojeda@kernel.org \
--to=ojeda@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=benno.lossin@proton.me \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=brendan.higgins@linux.dev \
--cc=davidgow@google.com \
--cc=gary@garyguo.net \
--cc=kunit-dev@googlegroups.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=nmi@metaspace.dk \
--cc=patches@lists.linux.dev \
--cc=philip.li@intel.com \
--cc=rust-for-linux@vger.kernel.org \
--cc=wedsonaf@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).