lkml.org 
[lkml]   [2012]   [Aug]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
SubjectRe: 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?

How does the attached patch look?

Thierry
From cd3199b94e697cccd38766b4a60d2e91474d0539 Mon Sep 17 00:00:00 2001
From: Thierry Reding <thierry.reding@avionic-design.de>
Date: Thu, 16 Aug 2012 08:01:21 +0200
Subject: [PATCH] pwm: Improve Kconfig help text

The Kconfig help text should help the user understand what functionality
is provided by an option. This is especially true for new subsystems. An
improved help text is provided by this commit in the hopes of clarifying
the usefulness of the PWM framework.

Signed-off-by: Thierry Reding <thierry.reding@avionic-design.de>
---
drivers/pwm/Kconfig | 24 ++++++++++++++++++------
1 file changed, 18 insertions(+), 6 deletions(-)
diff --git a/drivers/pwm/Kconfig b/drivers/pwm/Kconfig
index 8fc3808..88ddb9e 100644
--- a/drivers/pwm/Kconfig
+++ b/drivers/pwm/Kconfig
@@ -1,12 +1,24 @@
menuconfig PWM
- bool "PWM Support"
+ bool "Pulse-Width Modulation (PWM) Support"
depends on !MACH_JZ4740 && !PUV3_PWM
help
- This enables PWM support through the generic PWM framework.
- You only need to enable this, if you also want to enable
- one or more of the PWM drivers below.
-
- If unsure, say N.
+ Generic Pulse-Width Modulation (PWM) support.
+
+ This framework provides a generic interface to PWM devices
+ within the Linux kernel. On the driver side it provides an API
+ to register and unregister a PWM chip, an abstraction of a PWM
+ controller, that supports one or more PWM devices. Client
+ drivers can request PWM devices and use the generic framework
+ to configure as well as enable and disable them.
+
+ The new generic framework replaces the legacy PWM framework
+ which allows only a single driver implementing the required
+ API. Not all legacy implementations have been ported to the
+ new framework yet. The new framework provides an API that is
+ backward compatible with the legacy framework so that existing
+ client drivers continue to work as expected.
+
+ If unsure, say no.

if PWM

--
1.7.11.5
[unhandled content-type:application/pgp-signature]
\
 
 \ /
  Last update: 2012-08-16 12:22    [W:0.102 / U:0.460 seconds]
©2003-2014 Jasper Spaans. Advertise on this site