Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
MIME-Version: 1.0
References: <1574906800-19901-1-git-send-email-krzk@kernel.org>
 <87a78gnyaz.fsf@intel.com> <ab3309596fac1c5a0cb4e0abed0cf1ee7ac13a3d.camel@perches.com>
 <CAJKOXPdqn7+ucwqu2vJFL9ggCerpBz1qN6BSJvcsi4BQ3DU6fg@mail.gmail.com>
In-Reply-To: <CAJKOXPdqn7+ucwqu2vJFL9ggCerpBz1qN6BSJvcsi4BQ3DU6fg@mail.gmail.com>
From:   Krzysztof Kozlowski <krzk@kernel.org>
Date:   Tue, 3 Dec 2019 16:55:05 +0800
Message-ID: <CAJKOXPdJ=-yPR8-=4DiREXj6aA+Qufn_uFhViyWU+mSvqPu9cA@mail.gmail.com>
Subject: Re: [PATCH] checkpatch: Look for Kconfig indentation errors
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>
Content-Type: text/plain; charset="UTF-8"
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Tue, 3 Dec 2019 at 16:40, Krzysztof Kozlowski <krzk@kernel.org> wrote:
>
> 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-]/)) {

This unfortunately fails if help text starts with one of syntax
keywords (e.g. "if"). Isn't this getting over-complicated? The Kconfig
is rather simple:
1. no indentation,
2. one tab,
3. one tab + 2 spaces
4. one tab + 2 spaces + some more spaces (e.g. help text)

Best regards,
Krzysztof