From: Nicolai Fischer <nicolai.fischer@fau.de>
To: linux-kernel@vger.kernel.org
Cc: joe@perches.com, apw@canonical.com, akpm@linux-foundation.org,
nicolai.fischer@fau.de, johannes.czekay@fau.de,
linux-kernel@i4.cs.fau.de
Subject: [PATCH v3 5/5] checkpatch: kconfig: enforce block indentation
Date: Sun, 3 Jan 2021 08:50:15 +0100 [thread overview]
Message-ID: <20210103075015.23946-6-nicolai.fischer@fau.de> (raw)
In-Reply-To: <20210103075015.23946-1-nicolai.fischer@fau.de>
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.
Co-developed-by: Johannes Czekay <johannes.czekay@fau.de>
Signed-off-by: Johannes Czekay <johannes.czekay@fau.de>
Signed-off-by: Nicolai Fischer <nicolai.fischer@fau.de>
---
scripts/checkpatch.pl | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 805b5870803f..8a82ea5c2eb3 100755
--- a/scripts/checkpatch.pl
+++ b/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");
--
2.29.2
prev parent reply other threads:[~2021-01-03 7:51 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-14 10:22 [PATCH 0/2] checkpatch: update kconfig parsing Nicolai Fischer
2020-12-26 14:05 ` [PATCH v2 0/4] " Nicolai Fischer
2020-12-26 14:05 ` [PATCH v2 1/4] checkpatch: kconfig: replace '---help---' with 'help' Nicolai Fischer
2020-12-26 14:05 ` [PATCH v2 2/4] checkpatch: kconfig: add missing types to regex Nicolai Fischer
2020-12-26 14:05 ` [PATCH v2 3/4] checkpatch: kconfig: enforce help text indentation Nicolai Fischer
2020-12-26 15:50 ` Joe Perches
2020-12-26 14:05 ` [PATCH v2 4/4] checkpatch: kconfig: clarify warning for paragraph length Nicolai Fischer
2021-01-03 7:50 ` [PATCH v3 0/5] update kconfig parsing Nicolai Fischer
2021-01-03 7:50 ` [PATCH v3 1/5] checkpatch: kconfig: replace '---help---' with 'help' Nicolai Fischer
2021-01-03 7:50 ` [PATCH v3 2/5] checkpatch: kconfig: add missing types to regex Nicolai Fischer
2021-01-03 7:50 ` [PATCH v3 3/5] checkpatch: kconfig: enforce help text indentation Nicolai Fischer
2021-01-04 22:09 ` Joe Perches
2021-01-05 8:57 ` Joe Perches
2021-01-05 15:49 ` Nicolai Fischer
2021-01-03 7:50 ` [PATCH v3 4/5] checkpatch: kconfig: clarify warning for paragraph length Nicolai Fischer
2021-01-03 7:50 ` Nicolai Fischer [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210103075015.23946-6-nicolai.fischer@fau.de \
--to=nicolai.fischer@fau.de \
--cc=akpm@linux-foundation.org \
--cc=apw@canonical.com \
--cc=joe@perches.com \
--cc=johannes.czekay@fau.de \
--cc=linux-kernel@i4.cs.fau.de \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®