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

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.

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

docs: rust: clean up empty `\\\` lines and improve rustdoc formatting

You're welcome Hridesh!

https://lore.kernel.org/rust-for-linux/20240909161749.147076-1-hridesh699@gmail.com/

rust: kernel: clean up empty `///` lines

checkpatch: warn on empty rust doc comments

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);
    }
}
```

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.

rust: kernel: clean up empty `///` lines

checkpatch: warn on empty rust doc comments

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!

rust: kernel: clean up empty `///` lines

checkpatch: warn on empty rust doc comments

Navigation Menu

Repository navigation

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

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

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

Description

Activity

hrideshmg commented on Sep 8, 2024

ojeda commented on Sep 10, 2024

leonardotomascostadasilva commented on Sep 15, 2024

hrideshmg commented on Sep 16, 2024

leonardotomascostadasilva commented on Sep 20, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

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