[PATCH v2 1/2] rust: kernel: clean up empty `///` lines

[PATCH v2 1/2] rust: kernel: clean up empty `///` lines

[Hridesh MG]

From: hridesh <hridesh699@gmail.com>

Remove unnecessary empty `///` lines in the rust docs.

Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1109
Signed-off-by: Hridesh MG <hridesh699@gmail.com>
---
Changes in v2:
- Fixed typo in commit title and description
- Removed backslashes in kernel::block::mq::Request
- Link to v1: https://lore.kernel.org/rust-for-linux/20240909161749.147076-1-hridesh699@gmail.com/

Huge thanks to Benno Lossin and Miguel Ojeda for taking the time to
review my first patch
---
 rust/kernel/block/mq/request.rs | 1 -
 rust/kernel/rbtree.rs           | 1 -
 2 files changed, 2 deletions(-)

diff --git a/rust/kernel/block/mq/request.rs b/rust/kernel/block/mq/request.rs
index a0e22827f3f4..313334b1bf18 100644
--- a/rust/kernel/block/mq/request.rs
+++ b/rust/kernel/block/mq/request.rs
@@ -30,7 +30,6 @@
 /// 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

[PATCH v2 2/2] checkpatch: warn on empty rust doc comments

[Hridesh MG]

From: hridesh <hridesh699@gmail.com>

Add a check to warn if there are consecutive empty `///` lines in rust
files.

Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1109
Signed-off-by: Hridesh MG <hridesh699@gmail.com>
---
No changes in v2, this is a new patch
---
 scripts/checkpatch.pl | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 39032224d504..c75bc3927bf6 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3884,6 +3884,13 @@ sub process {
 			}
 		}
 
+# check for consecutive empty /// lines in .rs files
+		if ($realfile =~ /\.rs$/ &&
+		    $rawline =~ /^\+\s*\/\/\/$/ && $prevrawline =~ /^\+\s*\/\/\/$/) {
+			WARN("RUST_DOC_EMPTY",
+			     "avoid using consecutive empty rustdoc comments\n" . $herecurr);
+		}
+
 # check for adding lines without a newline.
 		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
 			if (WARN("MISSING_EOF_NEWLINE",
-- 
2.46.0

Re: [PATCH v2 1/2] rust: kernel: clean up empty `///` lines

[Greg KH]

On Wed, Sep 11, 2024 at 11:14:34PM +0530, Hridesh MG wrote:
> From: hridesh <hridesh699@gmail.com>
> 
> Remove unnecessary empty `///` lines in the rust docs.
> 
> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
> Link: https://github.com/Rust-for-Linux/linux/issues/1109
> Signed-off-by: Hridesh MG <hridesh699@gmail.com>

This name needs to match your "From:" line, sorry.  Can you fix that up
and send a v3 series?

thanks,

greg k-h

Re: [PATCH v2 1/2] rust: kernel: clean up empty `///` lines

[Hridesh MG]

On Thu, Sep 12, 2024 at 10:43 AM Greg KH <gregkh@linuxfoundation.org> wrote:
>
> On Wed, Sep 11, 2024 at 11:14:34PM +0530, Hridesh MG wrote:
> > From: hridesh <hridesh699@gmail.com>
> >
> > Remove unnecessary empty `///` lines in the rust docs.
> >
>
> This name needs to match your "From:" line, sorry.  Can you fix that up
> and send a v3 series?

Sorry, that was an oversight on my side. I'll wait a few days before
sending v3 in case there is more feedback.

--
Best Regards,
Hridesh

Re: [PATCH v2 1/2] rust: kernel: clean up empty `///` lines

[Alice Ryhl]

On Wed, Sep 11, 2024 at 7:45 PM Hridesh MG <hridesh699@gmail.com> wrote:
>
> From: hridesh <hridesh699@gmail.com>
>
> Remove unnecessary empty `///` lines in the rust docs.
>
> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
> Link: https://github.com/Rust-for-Linux/linux/issues/1109
> Signed-off-by: Hridesh MG <hridesh699@gmail.com>

Other than what Greg mentioned, looks good to me.

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

[PATCH v3 1/2] rust: kernel: clean up empty `///` lines

[Hridesh MG]

Remove unnecessary empty `///` lines in the rust docs.

Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1109
Signed-off-by: Hridesh MG <hridesh699@gmail.com>
---
Changes in v2:
- Fixed typo in commit title and description
- Removed backslashes in kernel::block::mq::Request
- Link to v1: https://lore.kernel.org/rust-for-linux/20240909161749.147076-1-hridesh699@gmail.com/

Changes in v3:
- Fixed From: tag in patch header
---
 rust/kernel/block/mq/request.rs | 1 -
 rust/kernel/rbtree.rs           | 1 -
 2 files changed, 2 deletions(-)

diff --git a/rust/kernel/block/mq/request.rs b/rust/kernel/block/mq/request.rs
index a0e22827f3f4..313334b1bf18 100644
--- a/rust/kernel/block/mq/request.rs
+++ b/rust/kernel/block/mq/request.rs
@@ -30,7 +30,6 @@
 /// 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

[PATCH v3 2/2] checkpatch: warn on empty rust doc comments

[Hridesh MG]

Add a check to warn if there are consecutive empty `///` lines in rust
files.

Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1109
Signed-off-by: Hridesh MG <hridesh699@gmail.com>
---
No changes in v2, this is a new patch
No changes in v3
---
 scripts/checkpatch.pl | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 39032224d504..c75bc3927bf6 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3884,6 +3884,13 @@ sub process {
 			}
 		}
 
+# check for consecutive empty /// lines in .rs files
+		if ($realfile =~ /\.rs$/ &&
+		    $rawline =~ /^\+\s*\/\/\/$/ && $prevrawline =~ /^\+\s*\/\/\/$/) {
+			WARN("RUST_DOC_EMPTY",
+			     "avoid using consecutive empty rustdoc comments\n" . $herecurr);
+		}
+
 # check for adding lines without a newline.
 		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
 			if (WARN("MISSING_EOF_NEWLINE",
-- 
2.46.0

Re: [PATCH v3 2/2] checkpatch: warn on empty rust doc comments

[Hridesh MG]

Ah, sorry. I did not intend to post this version as a reply to the
previous thread, I wrongly assumed that editing the patch manually
wouldn't have side effects. Should I post it again or is this fine?

Re: [PATCH v3 2/2] checkpatch: warn on empty rust doc comments

[Gary Guo]

On Sat, 14 Sep 2024 21:01:24 +0530
Hridesh MG <hridesh699@gmail.com> wrote:

> Ah, sorry. I did not intend to post this version as a reply to the
> previous thread, I wrongly assumed that editing the patch manually
> wouldn't have side effects. Should I post it again or is this fine?

I don't know what happened, somehow in my email client I saw the old
replies to your v2 patch becomes reply to your v3 patch.

Did you somehow reuse Message-ID between v3 and v2? Not sure how that's
supposed to happen...

Best,
Gary

Re: [PATCH v3 2/2] checkpatch: warn on empty rust doc comments

[Hridesh MG]

On Sat, Sep 14, 2024 at 10:12 PM Gary Guo <gary@garyguo.net> wrote:
>
> On Sat, 14 Sep 2024 21:01:24 +0530
> Hridesh MG <hridesh699@gmail.com> wrote:
>
> > Ah, sorry. I did not intend to post this version as a reply to the
> > previous thread, I wrongly assumed that editing the patch manually
> > wouldn't have side effects. Should I post it again or is this fine?
>
> I don't know what happened, somehow in my email client I saw the old
> replies to your v2 patch becomes reply to your v3 patch.
>
> Did you somehow reuse Message-ID between v3 and v2? Not sure how that's
> supposed to happen...
>
> Best,
> Gary

Yeah, I did not run git format-patch again to create v3. That messed
everything up.