diff mbox series

docs: gpio: Fix formatting in description of gpiod_*_array_* functions

Message ID 20210101200052.967482-1-j.neuschaefer@gmx.net
State New
Headers show
Series docs: gpio: Fix formatting in description of gpiod_*_array_* functions | expand

Commit Message

Jonathan Neuschäfer Jan. 1, 2021, 8 p.m. UTC
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 <j.neuschaefer@gmx.net>
---
 Documentation/driver-api/gpio/consumer.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

--
2.29.2

Comments

Bartosz Golaszewski Jan. 3, 2021, 3:28 p.m. UTC | #1
On Fri, Jan 1, 2021 at 9:09 PM Jonathan Neuschäfer
<j.neuschaefer@gmx.net> wrote:
>
> 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 <j.neuschaefer@gmx.net>
> ---
>  Documentation/driver-api/gpio/consumer.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/driver-api/gpio/consumer.rst b/Documentation/driver-api/gpio/consumer.rst
> index 173e4c7b037d0..22271c342d923 100644
> --- a/Documentation/driver-api/gpio/consumer.rst
> +++ b/Documentation/driver-api/gpio/consumer.rst
> @@ -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
>

Applied, thanks!

Bartosz
diff mbox series

Patch

diff --git a/Documentation/driver-api/gpio/consumer.rst b/Documentation/driver-api/gpio/consumer.rst
index 173e4c7b037d0..22271c342d923 100644
--- a/Documentation/driver-api/gpio/consumer.rst
+++ b/Documentation/driver-api/gpio/consumer.rst
@@ -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