Re: [PATCH 3/3] checkpatch: relax Kconfig help text line number threshold

[Yingjoe Chen]

On Thu, 2016-04-21 at 10:39 -0700, Andi Kleen wrote:
> On Thu, Apr 21, 2016 at 10:00:07AM -0700, Joe Perches wrote:
> > On Thu, 2016-04-21 at 21:28 +0800, Yingjoe Chen wrote:
> > > Current threshold is too strict and many upstream patch doesn't pass
> > > this test. Relax it.
> > 
> > I don't have an issue with this.
> > Maybe Andi Kleen does though.
> 
> So you spend all this time developing your kernel feature and can't be bothered to
> write a real description? How should people even find out about it?


I think it depends. For some features it would be helpful to have more
description. However for many device drivers, 2 lines is enough. For
example, I think the following help text is helpful and clean.

+config PINCTRL_IPQ4019
+       tristate "Qualcomm IPQ4019 pin controller driver"
+       depends on GPIOLIB && OF
+       select PINCTRL_MSM
+       help
+         This is the pinctrl, pinmux, pinconf and gpiolib driver for the
+         Qualcomm TLMM block found in the Qualcomm IPQ4019 platform.
+
+config SND_SOC_PCM179X_I2C
+       tristate "Texas Instruments PCM179X CODEC (I2C)"
+       depends on I2C
+       select SND_SOC_PCM179X
+       help
+         Enable support for Texas Instruments PCM179x CODEC.
+         Select this if your PCM179x is connected via an I2C bus.

Joe.C