cehckpatch config symbol description false positive

cehckpatch config symbol description false positive

[Geert Uytterhoeven]

Hi Andy, Joe,

When running checkpatch on
http://marc.info/?l=linux-sh&m=141227657322649&w=2
I get a false positive about the Kconfig symbol I just introduced, incl. a help
text:

WARNING: please write a paragraph that describes the config symbol fully
#60: FILE: arch/arm/Kconfig.debug:702:
+ config DEBUG_SCIF

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds

Re: cehckpatch config symbol description false positive

[Paul Bolle]

Geert Uytterhoeven schreef op do 02-10-2014 om 21:08 [+0200]:
> When running checkpatch on
> http://marc.info/?l=linux-sh&m=141227657322649&w=2
> I get a false positive about the Kconfig symbol I just introduced, incl. a help
> text:
> 
> WARNING: please write a paragraph that describes the config symbol fully
> #60: FILE: arch/arm/Kconfig.debug:702:
> + config DEBUG_SCIF

When you add one single line to your help (say, "Bla bla.") the warning
disappears. So you hit this test:
    "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);

because the paragraph was just three lines. It seems a length of one,
two, or three lines can be OK. It depends. Perhaps the test should just
be:
    [...] && $length);


Paul Bolle

Re: checkpatch config symbol description false positive

[Joe Perches]

On Thu, 2014-10-02 at 21:31 +0200, Paul Bolle wrote:
> Geert Uytterhoeven schreef op do 02-10-2014 om 21:08 [+0200]:
> > When running checkpatch on
> > http://marc.info/?l=linux-sh&m=141227657322649&w=2
> > I get a false positive about the Kconfig symbol I just introduced, incl. a help
> > text:
> > 
> > WARNING: please write a paragraph that describes the config symbol fully
> > #60: FILE: arch/arm/Kconfig.debug:702:
> > + config DEBUG_SCIF
> 
> When you add one single line to your help (say, "Bla bla.") the warning
> disappears. So you hit this test:
>     "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
> 
> because the paragraph was just three lines. It seems a length of one,
> two, or three lines can be OK. It depends. Perhaps the test should just
> be:
>     [...] && $length);

I generally agree.
I think the 4 line paragraph requirement is a bit much myself.

There is a patch in -next that allows a command line or a
.config file override.

commit 77b0cf564fa797e390e0ea29c953ac32bec87994
Author: Vadim Bendebury <vbendeb@chromium.org>
Date:   Fri Sep 26 10:19:28 2014 +1000

    checkpatch: allow optional shorter config descriptions
    
    This script is used by many other projects, and in some of them the
    requirement of at least 4 line long description for all Kconfig items is
    excessive.  This patch adds a command line option to control the required
    minimum length.
    
    Tested running this script over a patch including a two line config
    description.  The script generated a warning when invoked as is, and did
    not generate it when invoked with --min-conf-desc-length=2.
    
    Signed-off-by: Vadim Bendebury <vbendeb@chromium.org>
    Acked-by: Joe Perches <joe@perches.com>
    Signed-off-by: Andrew Morton <akpm@linux-foundation.org>