lkml.org 
[lkml]   [2021]   [Jan]   [3]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [PATCH] docs: gpio: Fix formatting in description of gpiod_*_array_* functions
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

\
 
 \ /
  Last update: 2021-01-03 16:31    [W:0.047 / U:0.288 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site