]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/commitdiff
iio:dummy: Add extra paragraphs on Kconfig
authorRodrigo Siqueira <rodrigosiqueiramelo@gmail.com>
Tue, 27 Feb 2018 13:47:06 +0000 (10:47 -0300)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sat, 3 Mar 2018 15:20:16 +0000 (15:20 +0000)
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>
Reviewed-by: Daniel Baluta <daniel.baluta@nxp.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
drivers/iio/dummy/Kconfig

index 85e13b2e35bf763d8cd8092bb2559c529a6ba3ac..c4fd108e91d3921953647a2d529bb5d2e01039c0 100644 (file)
@@ -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