The patch titled
Subject: checkpatch: kconfig: enforce block indentation
has been added to the -mm tree. Its filename is
checkpatch-kconfig-enforce-block-indentation.patch
This patch should soon appear at
https://ozlabs.org/~akpm/mmots/broken-out/checkpatch-kconfig-enforce-block-indentation.patch
and later at
https://ozlabs.org/~akpm/mmotm/broken-out/checkpatch-kconfig-enforce-block-indentation.patch
Before you just go and hit "reply", please:
a) Consider who else should be cc'ed
b) Prefer to cc a suitable mailing list as well
c) Ideally: find the original patch on the mailing list and do a
reply-to-all to that, adding suitable additional cc's
*** Remember to use Documentation/process/submit-checklist.rst when testing your code ***
The -mm tree is included into linux-next and is updated
there every 3-4 working days
------------------------------------------------------
From: Nicolai Fischer <nicolai.fischer@xxxxxx>
Subject: checkpatch: kconfig: enforce block indentation
Adds a new warning to checkpatch in case a new Kconfig block is not
indented one sigle tab more than the keyword which starts it.
Link: https://lkml.kernel.org/r/20210103075015.23946-6-nicolai.fischer@xxxxxx
Co-developed-by: Johannes Czekay <johannes.czekay@xxxxxx>
Signed-off-by: Johannes Czekay <johannes.czekay@xxxxxx>
Signed-off-by: Nicolai Fischer <nicolai.fischer@xxxxxx>
Cc: Joe Perches <joe@xxxxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
---
scripts/checkpatch.pl | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
--- a/scripts/checkpatch.pl~checkpatch-kconfig-enforce-block-indentation
+++ a/scripts/checkpatch.pl
@@ -3306,7 +3306,8 @@ sub process {
# 'choice' is usually the last thing on the line (though
# Kconfig supports named choices), so use a word boundary
# (\b) rather than a whitespace character (\s)
- $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
+ $line =~ /^\+(\s*)(?:config|menuconfig|choice)\b/) {
+ my $base_indent = $1;
my $length = 0;
my $cnt = $realcnt;
my $ln = $linenr + 1;
@@ -3315,6 +3316,7 @@ sub process {
my $is_end = 0;
my $help_indent;
my $help_stat_real;
+ my $block_stat_real;
for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
$f = $lines[$ln - 1];
$cnt-- if ($lines[$ln - 1] !~ /^-/);
@@ -3323,7 +3325,10 @@ sub process {
next if ($f =~ /^-/);
last if (!$file && $f =~ /^\@\@/);
- if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|int|hex|string|prompt)\s*(?:["'].*)?$/) {
+ if ($lines[$ln - 1] =~ /^\+(\s*)(?:bool|tristate|int|hex|string|prompt)\s*(?:["'].*)?$/) {
+ if ($1 !~ /^$base_indent\t$/) {
+ $block_stat_real = get_stat_real($linenr, $ln);
+ }
$is_start = 1;
} elsif ($lines[$ln - 1] =~ /^\+(\s*)help$/) {
$help_indent = $1;
@@ -3358,6 +3363,10 @@ sub process {
WARN("CONFIG_DESCRIPTION",
"please write a paragraph ($length/$min_conf_desc_length lines) that describes the config symbol fully\n" . $herecurr);
}
+ if ($is_start && $is_end && defined $block_stat_real) {
+ WARN("CONFIG_DESCRIPTION",
+ "please indent the block a single tab more than the start\n" . "$here\n$block_stat_real\n");
+ }
if ($is_start && $is_end && defined $help_stat_real) {
WARN("CONFIG_DESCRIPTION",
"please indent the help text two spaces more than the keyword\n" . "$here\n$help_stat_real\n");
_
Patches currently in -mm which might be from nicolai.fischer@xxxxxx are
checkpatch-kconfig-replace-help-with-help.patch
checkpatch-kconfig-add-missing-types-to-regex.patch
checkpatch-kconfig-enforce-help-text-indentation.patch
checkpatch-kconfig-clarify-warning-for-paragraph-length.patch
checkpatch-kconfig-enforce-block-indentation.patch
