[PATCH] staging: iio: adc: Add paragraph to describe Kconfig symbol

[PATCH] staging: iio: adc: Add paragraph to describe Kconfig symbol

[Vatsala Narang]

This patch updates Kconfig with paragraph that describe config symbol
fully.Issue addressed by checkpatch.

Signed-off-by: Vatsala Narang <vatsalanarang@gmail.com>
---
 drivers/staging/iio/adc/Kconfig | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/drivers/staging/iio/adc/Kconfig b/drivers/staging/iio/adc/Kconfig
index 23d9a655a520..31cd9a12f40f 100644
--- a/drivers/staging/iio/adc/Kconfig
+++ b/drivers/staging/iio/adc/Kconfig
@@ -12,6 +12,9 @@ config AD7816
 	  Say yes here to build support for Analog Devices AD7816/7/8
 	  temperature sensors and ADC.
 
+	  To compile this driver as a module, choose M here: the
+	  module will be called ad7816.
+
 config AD7192
 	tristate "Analog Devices AD7190 AD7192 AD7193 AD7195 ADC driver"
 	depends on SPI
-- 
2.17.1

Re: [PATCH] staging: iio: adc: Add paragraph to describe Kconfig symbol

[Jonathan Cameron]

On Wed,  1 May 2019 12:45:41 +0530
Vatsala Narang <vatsalanarang@gmail.com> wrote:

> This patch updates Kconfig with paragraph that describe config symbol
> fully.Issue addressed by checkpatch.
> 
> Signed-off-by: Vatsala Narang <vatsalanarang@gmail.com>
I'm not a great fan of that particular checkpatch warning as sometimes it
leads to silly details being added to things that really can be described
in very little text.

In this particular case the additional element of the module name seems
worth having though so applied to the togreg branch of iio.git and pushed
out as testing for the autobuilders to play with it.

Thanks,

Jonathan

> ---
>  drivers/staging/iio/adc/Kconfig | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/staging/iio/adc/Kconfig b/drivers/staging/iio/adc/Kconfig
> index 23d9a655a520..31cd9a12f40f 100644
> --- a/drivers/staging/iio/adc/Kconfig
> +++ b/drivers/staging/iio/adc/Kconfig
> @@ -12,6 +12,9 @@ config AD7816
>  	  Say yes here to build support for Analog Devices AD7816/7/8
>  	  temperature sensors and ADC.
>  
> +	  To compile this driver as a module, choose M here: the
> +	  module will be called ad7816.
> +
>  config AD7192
>  	tristate "Analog Devices AD7190 AD7192 AD7193 AD7195 ADC driver"
>  	depends on SPI