linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzk@kernel.org>
To: Joe Perches <joe@perches.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>,
	Andy Whitcroft <apw@canonical.com>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Subject: Re: [PATCH] checkpatch: Look for Kconfig indentation errors
Date: Tue, 3 Dec 2019 16:40:48 +0800	[thread overview]
Message-ID: <CAJKOXPdqn7+ucwqu2vJFL9ggCerpBz1qN6BSJvcsi4BQ3DU6fg@mail.gmail.com> (raw)
In-Reply-To: <ab3309596fac1c5a0cb4e0abed0cf1ee7ac13a3d.camel@perches.com>

On Thu, 28 Nov 2019 at 17:35, Joe Perches <joe@perches.com> wrote:
>
> On Thu, 2019-11-28 at 11:29 +0200, Jani Nikula wrote:
> > On Thu, 28 Nov 2019, Krzysztof Kozlowski <krzk@kernel.org> wrote:
> > > Kconfig should be indented with one tab for first level and tab+2 spaces
> > > for second level.  There are many mixups of this so add a checkpatch
> > > rule.
> > >
> > > Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org>
> >
> > I agree unifying the indentation is nice, and without something like
> > this it'll start bitrotting before Krzysztof's done fixing them all... I
> > think there's been quite a few fixes merged lately.
> >
> > I approve of the idea, but I'm clueless about the implementation.
>
> I think that a grammar, or a least an array of words
> that are supposed to start on a tab should be used here.

This won't work for wrong indentation of help text. This is quite
popular Kconfig indentation violation so worth checking. I can then
check for:
1. any white-space violations before array of Kconfig words - that
2. spaces mixed with tab before any text,
3. just spaces before any text,
4. tab + wrong number of spaces before any text.

It would look like:
+               if ($realfile =~ /Kconfig/ &&
+                   (($rawline =~
/^\+\s+(?:config|menuconfig|choice|endchoice|if|endif|menu|endmenu|source|bool|tristate|prompt|help|---help---|depends|select)\b/
&&
+                     $rawline !~ /^\+\t[a-z-]/) ||
+                    $rawline =~ /^\+\t* +\t+ *[a-zA-Z0-9-]/ ||
+                    $rawline =~ /^\+\t( |   )[a-zA-Z0-9-]/)) {

Best regards,
Krzysztof

  reply	other threads:[~2019-12-03  8:41 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-28  2:06 [PATCH] checkpatch: Look for Kconfig indentation errors Krzysztof Kozlowski
2019-11-28  9:29 ` Jani Nikula
2019-11-28  9:34   ` Joe Perches
2019-12-03  8:40     ` Krzysztof Kozlowski [this message]
2019-12-03  8:55       ` Krzysztof Kozlowski
2019-12-03  8:56       ` Joe Perches
2019-12-03  9:23         ` Jani Nikula
2019-12-03  9:38           ` Joe Perches

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=CAJKOXPdqn7+ucwqu2vJFL9ggCerpBz1qN6BSJvcsi4BQ3DU6fg@mail.gmail.com \
    --to=krzk@kernel.org \
    --cc=apw@canonical.com \
    --cc=jani.nikula@linux.intel.com \
    --cc=joe@perches.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pierre-louis.bossart@linux.intel.com \
    /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;
as well as URLs for NNTP newsgroup(s).