linux-kernel - Re: Checkpatch problem with Kconfig help symbol ?

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <m24o8o7k6o.fsf@linux.intel.com>
Date:	Mon, 31 Jan 2011 15:00:31 -0800
From:	Andi Kleen <ak@...ux.intel.com>
To:	Andy Whitcroft <apw@...onical.com>,
	Tomas Winkler <tomasw@...il.com>
Cc:	tapio.vihuri@...ia.com, ext Michal Marek <mmarek@...e.cz>,
	WANG Cong <xiyou.wangcong@...il.com>,
	linux-kernel@...r.kernel.org
Subject: Re: Checkpatch problem with Kconfig help symbol ?

Tomas Winkler <tomasw@...il.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.

-Andi
-- 
ak@...ux.intel.com -- Speaking for myself only
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/