From: hridesh <hridesh699@gmail.com>
To: linux-block@vger.kernel.org, rust-for-linux@vger.kernel.org,
linux-kernel@vger.kernel.org
Cc: "Andreas Hindborg" <a.hindborg@samsung.com>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Wedson Almeida Filho" <wedsonaf@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>,
"Trevor Gross" <tmgross@umich.edu>,
"Jens Axboe" <axboe@kernel.dk>, hridesh <hridesh699@gmail.com>,
"Matt Gilbride" <mattgilbride@google.com>,
"Shuah Khan" <skhan@linuxfoundation.org>
Subject: [PATCH] docs: rust: clean up empty `\\\` lines and improve rustdoc formatting
Date: Mon, 9 Sep 2024 21:47:49 +0530 [thread overview]
Message-ID: <20240909161749.147076-1-hridesh699@gmail.com> (raw)
Remove unnecessary empty `\\\` lines in the rust docs. Also add linebreaks
in kernel::block::mq::Request to fix formatting
Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1109
Signed-off-by: hridesh <hridesh699@gmail.com>
---
rust/kernel/block/mq/request.rs | 7 +++----
rust/kernel/rbtree.rs | 1 -
2 files changed, 3 insertions(+), 5 deletions(-)
diff --git a/rust/kernel/block/mq/request.rs b/rust/kernel/block/mq/request.rs
index a0e22827f3f4..3ab2917c9d25 100644
--- a/rust/kernel/block/mq/request.rs
+++ b/rust/kernel/block/mq/request.rs
@@ -22,15 +22,14 @@
///
/// There are four states for a request that the Rust bindings care about:
///
-/// A) Request is owned by block layer (refcount 0)
+/// A) Request is owned by block layer (refcount 0)\
/// B) Request is owned by driver but with zero `ARef`s in existence
-/// (refcount 1)
+/// (refcount 1)\
/// C) Request is owned by driver with exactly one `ARef` in existence
-/// (refcount 2)
+/// (refcount 2)\
/// D) Request is owned by driver with more than one `ARef` in existence
/// (refcount > 2)
///
-///
/// We need to track A and B to ensure we fail tag to request conversions for
/// requests that are not owned by the driver.
///
diff --git a/rust/kernel/rbtree.rs b/rust/kernel/rbtree.rs
index 25eb36fd1cdc..006f6e03aba5 100644
--- a/rust/kernel/rbtree.rs
+++ b/rust/kernel/rbtree.rs
@@ -1031,7 +1031,6 @@ fn next(&mut self) -> Option<Self::Item> {
/// A memory reservation for a red-black tree node.
///
-///
/// It contains the memory needed to hold a node that can be inserted into a red-black tree. One
/// can be obtained by directly allocating it ([`RBTreeNodeReservation::new`]).
pub struct RBTreeNodeReservation<K, V> {
--
2.46.0
next reply other threads:[~2024-09-09 16:19 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-09-09 16:17 hridesh [this message]
2024-09-09 19:21 ` [PATCH] docs: rust: clean up empty `\\\` lines and improve rustdoc formatting Benno Lossin
2024-09-10 11:10 ` Miguel Ojeda
2024-09-10 13:30 ` Miguel Ojeda
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=20240909161749.147076-1-hridesh699@gmail.com \
--to=hridesh699@gmail.com \
--cc=a.hindborg@samsung.com \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=axboe@kernel.dk \
--cc=benno.lossin@proton.me \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=gary@garyguo.net \
--cc=linux-block@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mattgilbride@google.com \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=tmgross@umich.edu \
--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