linux-kernel - Re: awful kconfig help texts.

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: <20120801074335.GG29673@avionic-0098.adnet.avionic-design.de>
Date:	Wed, 1 Aug 2012 09:43:35 +0200
From:	Thierry Reding <thierry.reding@...onic-design.de>
To:	Borislav Petkov <bp@...en8.de>, Dave Jones <davej@...hat.com>,
	Linux Kernel <linux-kernel@...r.kernel.org>
Subject: Re: awful kconfig help texts.

On Tue, Jul 31, 2012 at 07:07:41PM +0200, Borislav Petkov wrote:
> On Tue, Jul 31, 2012 at 11:16:00AM -0400, Dave Jones wrote:
> > 
> > PWM Support (PWM) [N/y/?] (NEW) ?
> > 
> > CONFIG_PWM:
> > 
> > This enables PWM support through the generic PWM framework.
> > 
> > 
> > Well that's.. enlightening.
> 
> Oh, there's one more enlightening sentence in the help:
> 
> "You only need to enable this, if you also want to enable one or more of
> the PWM drivers below."
> 
> Got it? :-)
> 
> > I'm picking on PWM here, but this isn't an
> > isolated case.  Every merge window we see a slew of new options with useless
> > help texts. They may as well be non-existent. (Actually in some cases, they are).
> > 
> > If someone has to read the code to find out what the driver is, your help text probably sucks.
> > 
> > 
> > (I'll leave "why does this option even show up on x86" as a separate rant)
> 
> Thierry, can you guys please fix this?

Hehe, those aren't very descriptive, that's true. I was going to go over
the documentation anyway, so I'll make a note to revise the Kconfig help
texts as well.

Thierry

Content of type "application/pgp-signature" skipped