checkpatch: warn on empty rust doc comments

hrideshmg · intel-lab-lkp · commit b64a13ca59cf · 2024-09-12T01:47:29.000+08:00
Add a check to warn if there are consecutive empty `///` lines in rust files. Suggested-by: Miguel Ojeda <ojeda@kernel.org> Link: Rust-for-Linux#1109 Signed-off-by: Hridesh MG <hridesh699@gmail.com>
diff --git 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",

Original file line number	Diff line number	Diff line change
`@@ -3884,6 +3884,13 @@ sub process {`
`3884`	`3884`	`}`
`3885`	`3885`	`}`
`3886`	`3886`
	`3887`	`+# check for consecutive empty /// lines in .rs files`
	`3888`	`+ if ($realfile =~ /\.rs$/ &&`
	`3889`	`+ $rawline =~ /^\+\s\/\/\/$/ && $prevrawline =~ /^\+\s\/\/\/$/) {`
	`3890`	`+ WARN("RUST_DOC_EMPTY",`
	`3891`	`+ "avoid using consecutive empty rustdoc comments\n" . $herecurr);`
	`3892`	`+ }`
	`3893`	`+`
`3887`	`3894`	`# check for adding lines without a newline.`
`3888`	`3895`	`if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {`
`3889`	`3896`	`if (WARN("MISSING_EOF_NEWLINE",`