linux-kernel - Re: [PATCH] docs: gpio: Fix formatting in description of gpiod_*_array

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAMpxmJVQ_zhV_Bc+CgREd45QzV4FpPGTqi9sBCSUVR9g+Pqy=g@mail.gmail.com>
Date:   Sun, 3 Jan 2021 16:28:42 +0100
From:   Bartosz Golaszewski <bgolaszewski@...libre.com>
To:     Jonathan Neuschäfer <j.neuschaefer@....net>
Cc:     linux-doc <linux-doc@...r.kernel.org>,
        Linus Walleij <linus.walleij@...aro.org>,
        Jonathan Corbet <corbet@....net>,
        linux-gpio <linux-gpio@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>
Subject: Re: [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@....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@....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