Re: [PATCH v2 2/2] iio:dummy: Add extra paragraphs on Kconfig

[Jonathan Cameron]

On Tue, 27 Feb 2018 10:47:06 -0300
Rodrigo Siqueira <rodrigosiqueiramelo@xxxxxxxxx> wrote:

> This patch fixes the checkpatch.pl warning:
> 
> drivers/iio/dummy/Kconfig:21: WARNING: please write a paragraph that
> describes the config symbol fully
> drivers/iio/dummy/Kconfig:27: WARNING: please write a paragraph that
> describes the config symbol fully
> 
> This patch expands the explanation about IIO_DUMMY_EVGEN by using the
> code documentation found in iio/dummy/iio_dummy_evgen.c. In the same
> way, the information related to IIO_SIMPLE_DUMMY_BUFFER was extracted
> from file iio_simple_dummy_buffer.c.
> 
> Signed-off-by: Rodrigo Siqueira <rodrigosiqueiramelo@xxxxxxxxx>
Applied to the togreg branch of iio.git and pushed out as testing
for the autobuilders to play with it,

Thanks,

Jonathan

> ---
>  drivers/iio/dummy/Kconfig | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/drivers/iio/dummy/Kconfig b/drivers/iio/dummy/Kconfig
> index 85e13b2e35bf..c4fd108e91d3 100644
> --- a/drivers/iio/dummy/Kconfig
> +++ b/drivers/iio/dummy/Kconfig
> @@ -24,6 +24,10 @@ config IIO_SIMPLE_DUMMY_EVENTS
>  	help
>  	  Add some dummy events to the simple dummy driver.
>  
> +	  The purpose of this is to generate 'fake' event interrupts thus
> +	  allowing that driver's code to be as close as possible to that
> +	  a normal driver talking to hardware.
> +
>  config IIO_SIMPLE_DUMMY_BUFFER
>  	bool "Buffered capture support"
>  	select IIO_BUFFER
> @@ -32,6 +36,9 @@ config IIO_SIMPLE_DUMMY_BUFFER
>  	help
>  	  Add buffered data capture to the simple dummy driver.
>  
> +	  Buffer handling elements of industrial I/O reference driver.
> +	  Uses the kfifo buffer.
> +
>  endif # IIO_SIMPLE_DUMMY
>  
>  endmenu