docs: gpio: Fix formatting in description of gpiod_*_array_* functions
Subsystems (2)
PATCH 1/1 docs: gpio: Fix formatting in description of gpiod_*_array_* functions
The gpiod_*_array_* functions take four arguments, not three. Additionally, the formatting of the "value_bitmap" line results in misformatted HTML, so fix that.
Signed-off-by Jonathan Neuschäfer <[email protected]>
--- Documentation/driver-api/gpio/consumer.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/driver-api/gpio/consumer.rst +3 -2
@@ -361,12 +361,13 @@ corresponding chip driver. In that case a significantly improved performance can be expected. If simultaneous access is not possible the GPIOs will be accessed sequentially. -The functions take three arguments: +The functions take four arguments: + * array_size - the number of array elements * desc_array - an array of GPIO descriptors * array_info - optional information obtained from gpiod_get_array() * value_bitmap - a bitmap to store the GPIOs' values (get) or - a bitmap of values to assign to the GPIOs (set) + a bitmap of values to assign to the GPIOs (set) The descriptor array can be obtained using the gpiod_get_array() function or one of its variants. If the group of descriptors returned by that function
--
2.29.2
Bartosz Golaszewski
AppliedQuoted 31 lines · Jonathan Neuschäfer
The gpiod_*_array_* functions take four arguments, not three. Additionally, the formatting of the "
value_bitmap" line results in misformatted HTML, so fix that.Signed-off-by Jonathan Neuschäfer <[email protected]>--- Documentation/driver-api/gpio/consumer.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)Documentation/driver-api/gpio/consumer.rst +3
-3@@ -361,12 +361,13 @@ corresponding chip driver. In that case a significantly improved performance can be expected. If simultaneous access is not possible the GPIOs will be accessed sequentially. -The functions take three arguments: +The functions take four arguments: + * array_size - the number of array elements * desc_array - an array of GPIO descriptors * array_info - optional information obtained from gpiod_get_array() * value_bitmap - a bitmap to store the GPIOs' values (get) or - a bitmap of values to assign to the GPIOs (set) + a bitmap of values to assign to the GPIOs (set) The descriptor array can be obtained using the gpiod_get_array() function or one of its variants. If the group of descriptors returned by that function --
Quoted 2 lines
2.29.2
Applied, thanks!
Bartosz