iio:dummy: Rework Kconfig

PATCH In review Rodrigo Siqueira 3 participants 6 messages Feb 27, 2018 – Mar 3, 2018

Subsystems (2)

Kernel janitors IIO

lore

Share & tools

lore

Rodrigo Siqueira

author

2018-02-27 13:46 UTC #0 lore raw

v2 cover iio:dummy: Rework Kconfig

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(-)

Signature · 1 line

2.16.2

Rodrigo Siqueira

author

2018-02-27 13:46 UTC #1 lore raw

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

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 <[email protected]>

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

drivers/iio/dummy/Kconfig +10 ~~-10~~

index 5a29fbd3c531..85e13b2e35bf 100644
@@ -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"

Signature · 1 line

2.16.2

Jonathan Cameron

maintainer

2018-03-03 15:21 UTC #2 lore raw

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

Quoted 6 lines · On Tue, 27 Feb 2018 10:46:51 -0300 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 <[email protected]>

Applied to the togreg branch of iio.git and pushed out as testing for the autobuilders to play with it.

Thanks,

Jonathan

Quoted 39 lines

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

drivers/iio/dummy/Kconfig +10 ~~-10~~

index 5a29fbd3c531..85e13b2e35bf 100644
@@ -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"

Rodrigo Siqueira

author

2018-02-27 13:47 UTC #3 lore raw

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

In reply to 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 <[email protected]>

---
 drivers/iio/dummy/Kconfig | 7 +++++++
 1 file changed, 7 insertions(+)

drivers/iio/dummy/Kconfig +7 -0

index 85e13b2e35bf..c4fd108e91d3 100644
@@ -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

Signature · 1 line

2.16.2

Jonathan Cameron

maintainer

2018-03-03 15:21 UTC #4 lore raw

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

Quoted 7 lines · On Tue, 27 Feb 2018 10:47:06 -0300 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

Quoted 6 lines

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 <[email protected]>

Applied to the togreg branch of iio.git and pushed out as testing for the autobuilders to play with it,

Thanks,

Jonathan

Quoted 29 lines

---
 drivers/iio/dummy/Kconfig | 7 +++++++
 1 file changed, 7 insertions(+)

drivers/iio/dummy/Kconfig +7 -0

index 85e13b2e35bf..c4fd108e91d3 100644
@@ -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

Daniel Baluta

Reviewed-by on the v2 series

2018-02-27 14:26 UTC #5 lore raw

In reply to Rodrigo Siqueira

Quoted 9 lines · 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

Reviewed-by Daniel Baluta <[email protected]>