lkml.org 
[lkml]   [2011]   [Jan]   [31]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: Checkpatch problem with Kconfig help symbol ?
    On Mon, Jan 31, 2011 at 12:15:10PM +0200, Tomas Winkler wrote:
    > On Mon, Jan 31, 2011 at 10:19 AM, Tapio Vihuri <tapio.vihuri@nokia.com> wrote:
    > > On Fri, 2011-01-21 at 10:17 +0000, ext Andy Whitcroft wrote:
    > >> On Fri, Jan 21, 2011 at 09:19:31AM +0200, Tapio Vihuri wrote:
    > >> > On Thu, 2011-01-20 at 10:38 +0100, ext Michal Marek wrote:
    > >> > > On 20.1.2011 09:06, WANG Cong wrote:
    > >> > > > On Wed, 19 Jan 2011 14:42:48 +0200, Tapio Vihuri wrote:
    > >> > > >
    > >> > > >> Hi
    > >> > > >>
    > >> > > >> Is this false positive ?
    > >> > > >>
    > >> > > >> WARNING: please write a paragraph that describes the config symbol fully
    > >> > > >> #60: FILE: drivers/input/misc/Kconfig:159: +       help
    > >> > > >>
    > >> > > >>
    > >> > > >> Interesting enough, also:
    > >> > > >>
    > >> > > >> ./scripts/checkpatch.pl --file drivers/input/misc/Kconfig WARNING:
    > >> > > >> please write a paragraph that describes the config symbol fully #430:
    > >> > > >> FILE: input/misc/Kconfig:430:
    > >> > > >> +       help
    > >> > > >>
    > >> > > >>
    > >> > > >> But this is different line.
    > >> > > >>
    > >> > > >
    > >> > > > Seems yes, the Kconfig part of your patch looks fine.
    > >> > >
    > >> > > The check is complaining that the help text is too short:
    > >> > >
    > >> > > +config ECI_CTRL_DEBUG
    > >> > > + bool "ECI controller debug"
    > >> > > + depends on INPUT_ECI_AT20
    > >> > > + help
    > >> > > +   Say Y here to enable debugging messages for ECI controller driver.
    > >> > >
    > >> > > Michal
    > >> >
    > >> > Hi.
    > >> >
    > >> > That I suspect, and I tried to add four lines more.
    > >> > But it still complain the same.
    > >>
    > >> If you have a patch which has four or more lines and trips this message
    > >> it is false yes.  Please do send me your example, as my current tests
    > >> pass.
    > >>
    > >> -apw
    > >
    > > Hi.
    > >
    > > Sorry for the delay, I had made stupid email filter. Mea Culpa.
    > >
    > > It's working OK. If there is only three lines of help, checkpatch will
    > > complain.
    > > With four lines, it's not.
    > >
    > > I add more help in my case. It toggle driver debug on/off, so I try
    > > harder to figure out how to say it with more words ;)
    > >
    > > BR,
    > > Tapio
    > >
    >
    > I believe that the warning is not descriptive enough, I also had to
    > look into the checkpatch script to
    > figure out what is going on.
    > What about adding little explanation like that:
    >
    > WARNING: please write a paragraph that describes the config symbol
    > fully (4 lines at least)

    Yeah that is a little better. I do remind you that if the description
    is good enough shorter than 4 lines then you can ignore checkpatch. It
    is a style guide not a style enforcer. You are allowed to ignore things
    if you can justify it.

    -apw
    --
    To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
    the body of a message to majordomo@vger.kernel.org
    More majordomo info at http://vger.kernel.org/majordomo-info.html
    Please read the FAQ at http://www.tux.org/lkml/

    \
     
     \ /
      Last update: 2011-01-31 14:45    [W:2.897 / U:0.192 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site