[PATCH v2 0/2] iio:dummy: Rework Kconfig

[PATCH v2 0/2] iio:dummy: Rework Kconfig

[Rodrigo Siqueira]

This series adds extra documentation inside iio/dummy/Kconfig, and
applies the coding-style to it.

Changes v2:
- Separates single patch in a short series.

Rodrigo Siqueira (2):
  iio: dummy: Add correct tabs and spaces to Kconfig
  iio:dummy: Add extra paragraphs on Kconfig

 drivers/iio/dummy/Kconfig | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)

-- 
2.16.2

[PATCH v2 1/2] iio: dummy: Add correct tabs and spaces to Kconfig

[Rodrigo Siqueira]

Kconfig from iio/dummy does not follow the coding style recommendations.
According to the coding-style, Lines under a config definition are
indented with one tab, while help text is indented an additional two
spaces. This patch adds the proper tabulation and space.

Signed-off-by: Rodrigo Siqueira <rodrigosiqueiramelo@gmail.com>
---
 drivers/iio/dummy/Kconfig | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/drivers/iio/dummy/Kconfig b/drivers/iio/dummy/Kconfig
index 5a29fbd3c531..85e13b2e35bf 100644
--- a/drivers/iio/dummy/Kconfig
+++ b/drivers/iio/dummy/Kconfig
@@ -9,20 +9,20 @@ config IIO_DUMMY_EVGEN
 	tristate
 
 config IIO_SIMPLE_DUMMY
-       tristate "An example driver with no hardware requirements"
-       depends on IIO_SW_DEVICE
-       help
-	 Driver intended mainly as documentation for how to write
-	 a driver. May also be useful for testing userspace code
-	 without hardware.
+	tristate "An example driver with no hardware requirements"
+	depends on IIO_SW_DEVICE
+	help
+	  Driver intended mainly as documentation for how to write
+	  a driver. May also be useful for testing userspace code
+	  without hardware.
 
 if IIO_SIMPLE_DUMMY
 
 config IIO_SIMPLE_DUMMY_EVENTS
-       bool "Event generation support"
-       select IIO_DUMMY_EVGEN
-       help
-         Add some dummy events to the simple dummy driver.
+	bool "Event generation support"
+	select IIO_DUMMY_EVGEN
+	help
+	  Add some dummy events to the simple dummy driver.
 
 config IIO_SIMPLE_DUMMY_BUFFER
 	bool "Buffered capture support"
-- 
2.16.2

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

[Rodrigo Siqueira]

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@gmail.com>
---
 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
-- 
2.16.2

Re: [PATCH v2 0/2] iio:dummy: Rework Kconfig

[Daniel Baluta]

On Tue, Feb 27, 2018 at 3:46 PM, Rodrigo Siqueira
<rodrigosiqueiramelo@gmail.com> wrote:
> This series adds extra documentation inside iio/dummy/Kconfig, and
> applies the coding-style to it.
>
> Changes v2:
> - Separates single patch in a short series.
>
> Rodrigo Siqueira (2):
>   iio: dummy: Add correct tabs and spaces to Kconfig
>   iio:dummy: Add extra paragraphs on Kconfig

Reviewed-by: Daniel Baluta <daniel.baluta@nxp.com>

Re: [PATCH v2 1/2] iio: dummy: Add correct tabs and spaces to Kconfig

[Jonathan Cameron]

On Tue, 27 Feb 2018 10:46:51 -0300
Rodrigo Siqueira <rodrigosiqueiramelo@gmail.com> wrote:

> Kconfig from iio/dummy does not follow the coding style recommendations.
> According to the coding-style, Lines under a config definition are
> indented with one tab, while help text is indented an additional two
> spaces. This patch adds the proper tabulation and space.
> 
> Signed-off-by: Rodrigo Siqueira <rodrigosiqueiramelo@gmail.com>
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 | 20 ++++++++++----------
>  1 file changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/drivers/iio/dummy/Kconfig b/drivers/iio/dummy/Kconfig
> index 5a29fbd3c531..85e13b2e35bf 100644
> --- a/drivers/iio/dummy/Kconfig
> +++ b/drivers/iio/dummy/Kconfig
> @@ -9,20 +9,20 @@ config IIO_DUMMY_EVGEN
>  	tristate
>  
>  config IIO_SIMPLE_DUMMY
> -       tristate "An example driver with no hardware requirements"
> -       depends on IIO_SW_DEVICE
> -       help
> -	 Driver intended mainly as documentation for how to write
> -	 a driver. May also be useful for testing userspace code
> -	 without hardware.
> +	tristate "An example driver with no hardware requirements"
> +	depends on IIO_SW_DEVICE
> +	help
> +	  Driver intended mainly as documentation for how to write
> +	  a driver. May also be useful for testing userspace code
> +	  without hardware.
>  
>  if IIO_SIMPLE_DUMMY
>  
>  config IIO_SIMPLE_DUMMY_EVENTS
> -       bool "Event generation support"
> -       select IIO_DUMMY_EVGEN
> -       help
> -         Add some dummy events to the simple dummy driver.
> +	bool "Event generation support"
> +	select IIO_DUMMY_EVGEN
> +	help
> +	  Add some dummy events to the simple dummy driver.
>  
>  config IIO_SIMPLE_DUMMY_BUFFER
>  	bool "Buffered capture support"

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@gmail.com> 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@gmail.com>
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