Commit 084a617a authored by Dwaipayan Ray's avatar Dwaipayan Ray Committed by Linus Torvalds

checkpatch: add warning for lines starting with a '#' in commit log

Commit log lines starting with '#' are dropped by git as comments.
Add a check to emit a warning for these lines.

Also add a --fix option to insert a space before the leading '#' in
such lines.

Link: https://lkml.kernel.org/r/20201202205740.127986-1-dwaipayanray1@gmail.comSigned-off-by: default avatarDwaipayan Ray <dwaipayanray1@gmail.com>
Suggested-by: default avatarJoe Perches <joe@perches.com>
Suggested-by: default avatarPeilin Ye <yepeilin.cs@gmail.com>
Tested-by: default avatarPeilin Ye <yepeilin.cs@gmail.com>
Acked-by: default avatarJoe Perches <joe@perches.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 70eb2275
...@@ -3033,6 +3033,15 @@ sub process { ...@@ -3033,6 +3033,15 @@ sub process {
$commit_log_possible_stack_dump = 0; $commit_log_possible_stack_dump = 0;
} }
# Check for lines starting with a #
if ($in_commit_log && $line =~ /^#/) {
if (WARN("COMMIT_COMMENT_SYMBOL",
"Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) &&
$fix) {
$fixed[$fixlinenr] =~ s/^/ /;
}
}
# Check for git id commit length and improperly formed commit descriptions # Check for git id commit length and improperly formed commit descriptions
if ($in_commit_log && !$commit_log_possible_stack_dump && if ($in_commit_log && !$commit_log_possible_stack_dump &&
$line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment