LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Tomas Winkler <tomasw@gmail.com>
To: Andi Kleen <ak@linux.intel.com>
Cc: Andy Whitcroft <apw@canonical.com>,
	tapio.vihuri@nokia.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: Tue, 1 Feb 2011 14:11:35 +0200	[thread overview]
Message-ID: <AANLkTi=64=wShhFbTK_Fdpwdnm3ryXK3VTrJCctGdB4J@mail.gmail.com> (raw)
In-Reply-To: <m24o8o7k6o.fsf@linux.intel.com>

On Tue, Feb 1, 2011 at 1:00 AM, Andi Kleen <ak@linux.intel.com> wrote:
> Tomas Winkler <tomasw@gmail.com> writes:
>
>>>
>>> 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.
>>
>> Please consider patch I've posted
>> http://marc.info/?l=linux-kernel&m=129647530611677&w=2
>
> I originally didn't put in the number intentionally to make
> it harder to game it. Most likely for a whole driver
> or whole subsystems 4 lines are not enough to describe
> it properly.
>
> But yes if it's just for a debug feature you can ignore it.
> But then most likely your debug feature shouldn't be
> in Kconfig in the first place, but some runtime setting
>
> (rule of thumb: if it controls less than 1KB of code it's
> likely a bad idea in Kconfig)
>
> And more complex debug features that do actually carry
> significant code should have proper description.
>
> I think a better change would be to describe this
> more fully, not add the number.

These are all valid points but current message just leave you puzzled
and you have to look inside checkpatch.pl to figure out what it wants.
I'm not sure how would you lay your thoughts concisely  in one line
warning or script them into the script.

My guess would be that most of the developers  tends to come witch
checkpatch.pl clean and even when you expose the number 4 it still
make them stop and think how to fill them properly. Maybe you can
squeeze into the waring  pointer to CodyingStyle section.

Thanks
Tomas

  reply	other threads:[~2011-02-01 12:11 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
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 [this message]
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=64=wShhFbTK_Fdpwdnm3ryXK3VTrJCctGdB4J@mail.gmail.com' \
    --to=tomasw@gmail.com \
    --cc=ak@linux.intel.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).