Clean consecutive empty /// lines and implement a checkpatch.pl check for it

[ojeda]

Clean up consecutive empty /// lines and implement a checkpatch.pl check for it. These should be two different patches.

At the time of writing, there are a couple instances at rust/kernel/rbtree.rs and rust/kernel/block/mq/request.rs.

Please note that the checkpatch.pl maintainers will need to agree to the change.

---

This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes (including generating the documentation if changed, running the Rust doctests if changed, etc.), to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and to add a Suggested-by: tag and a Link: tag to this issue. Please see https://rust-for-linux.com/contributing for details.

Please take this issue only if you are new to the kernel development process and you would like to use it as a test to submit your first patch to the kernel. Please do not take it if you do not plan to make other contributions to the kernel.

[hrideshmg]

Hi there! Would love to give this a go. Thanks for creating these for us beginners :)

[ojeda]

You're welcome Hridesh!

https://lore.kernel.org/rust-for-linux/[email protected]/

[leonardotomascostadasilva]

Wouldn't it be interesting to add a check whether a line has actually been added or modified? This would reduce checking for non-relevant lines

Something like that?

if ($realfile =~ /\.rs$/ && $line_type eq 'added') {
    if ($rawline =~ /^\+\s*\/\/\/$/ && $prevrawline =~ /^\+\s*\/\/\/$/) {
			WARN("RUST_DOC_EMPTY",
			     "avoid using consecutive empty rustdoc comments\n" . $herecurr);
    }
}
```

[hrideshmg]

This is already included in the regex that matches $rawline; it will only match lines in the diff that begin with a '+', implying that a line was added.

[leonardotomascostadasilva]

This is already included in the regex that matches $rawline; it will only match lines in the diff that begin with a '+', implying that a line was added.

Thanks for your feedback!