checkpatch: warn on empty rust doc comments

Add a check to warn if there are consecutive empty `///` lines in rust files. Suggested-by: Miguel Ojeda <[email protected]> Link: Rust-for-Linux#1109 Signed-off-by: Hridesh MG <[email protected]>
intel-lab-lkp · Sep 29, 2024 · f190bd0 · f190bd0
1 parent 60ababd
commit f190bd0
Showing 1 changed file with 7 additions and 0 deletions.
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",