2012-08-01 07:43:51

by Thierry Reding

[permalink] [raw]
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


Attachments:
(No filename) (1.08 kB)
(No filename) (836.00 B)
Download all attachments

2012-08-01 09:28:18

by Jan Engelhardt

[permalink] [raw]
Subject: Re: awful kconfig help texts.


On Wednesday 2012-08-01 09:43, Thierry Reding wrote:
>> >
>> > PWM Support (PWM) [N/y/?] (NEW) ?
>> >
>> > CONFIG_PWM:
>> > This enables PWM support through the generic PWM framework.
>>
>> 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? :-)
>> 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.

Also, instead of
bool "PWM Support"
this should be
menuconfig "PWM support"

so that you can disable the whole submenu at once.