LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Tomas Winkler <tomasw@gmail.com>
To: tapio.vihuri@nokia.com
Cc: ext Andy Whitcroft <apw@canonical.com>,
	ext Michal Marek <mmarek@suse.cz>,
	WANG Cong <xiyou.wangcong@gmail.com>,
	linux-kernel@vger.kernel.org
Subject: Re: Checkpatch problem with Kconfig help symbol ?
Date: Mon, 31 Jan 2011 12:15:10 +0200	[thread overview]
Message-ID: <AANLkTi=0Gpvtvi8RyHbPAeh__YWLLPz+dE7iMdFbgGEW@mail.gmail.com> (raw)
In-Reply-To: <1296461958.4168.5.camel@dell>

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)

Thanks
Tomas

  reply	other threads:[~2011-01-31 10:15 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-01-19 12:42 Tapio Vihuri
2011-01-20  8:06 ` WANG Cong
2011-01-20  9:38   ` Michal Marek
2011-01-21  7:19     ` Tapio Vihuri
2011-01-21 10:17       ` Andy Whitcroft
2011-01-31  8:19         ` Tapio Vihuri
2011-01-31 10:15           ` Tomas Winkler [this message]
2011-01-31 13:42             ` Andy Whitcroft
2011-01-31 19:08               ` Tomas Winkler
2011-01-31 23:00                 ` Andi Kleen
2011-02-01 12:11                   ` Tomas Winkler
2011-01-25  1:32 ` checkpatch file name stripped mode Milton Miller

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='AANLkTi=0Gpvtvi8RyHbPAeh__YWLLPz+dE7iMdFbgGEW@mail.gmail.com' \
    --to=tomasw@gmail.com \
    --cc=apw@canonical.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mmarek@suse.cz \
    --cc=tapio.vihuri@nokia.com \
    --cc=xiyou.wangcong@gmail.com \
    --subject='Re: Checkpatch problem with Kconfig help symbol ?' \
    /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

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).