Re: awful kconfig help texts.

From: Cam Hutchison
Date: Sun Aug 19 2012 - 22:43:53 EST


>How about the patch below?

>[...]
>+ Generic Pulse-Width Modulation (PWM) support.
>+
>+ In Pulse-Width Modulation, a variation of the width of pulses
>+ in a rectangular pulse signal is used as a means to alter the
>+ average power of the signal. Applications include efficient
>+ power delivery and voltage regulation. In computer systems,
>+ PWMs are commonly used to control fans or the brightness of
>+ display backlights.
>+
>+ 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.

Instead of writing "[Tt]he new framework", write "[Tt]his framework". In 4
years, this will no longer be so new. And when the next framework comes
along, this will look like it is referencing the new one instead of itself.


--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/