linux-kernel - Re: [PATCH v2] Documentation: gpio: fix function links in the HTML docs

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 for Android: free password hash cracker in your pocket

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

Message-ID: <CAMpxmJXanG_-Cet-VEg2=XHsZqCqqPJ9O8kUC+14u5-rr+ypkA@mail.gmail.com>
Date:   Tue, 30 Jul 2019 10:17:05 +0200
From:   Bartosz Golaszewski <bgolaszewski@...libre.com>
To:     Jeremy Cline <jcline@...hat.com>
Cc:     Linus Walleij <linus.walleij@...aro.org>,
        Jonathan Corbet <corbet@....net>,
        linux-gpio <linux-gpio@...r.kernel.org>,
        linux-doc <linux-doc@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v2] Documentation: gpio: fix function links in the HTML docs

pon., 29 lip 2019 o 16:37 Jeremy Cline <jcline@...hat.com> napisał(a):
>
> The shorthand [_data] and [devm_] cause the HTML documentation to not
> link to the function documentation properly. This expands the references
> to the complete function names with the exception of
> devm_gpiochip_remove() which was dropped by commit 48207d7595d2 ("gpio:
> drop devm_gpiochip_remove()").
>
> Signed-off-by: Jeremy Cline <jcline@...hat.com>
> ---
> New in v2:
>   - Rebased onto v5.3-rc2
>
>  Documentation/driver-api/gpio/driver.rst | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/Documentation/driver-api/gpio/driver.rst b/Documentation/driver-api/gpio/driver.rst
> index 921c71a3d683..906af220b164 100644
> --- a/Documentation/driver-api/gpio/driver.rst
> +++ b/Documentation/driver-api/gpio/driver.rst
> @@ -69,9 +69,9 @@ driver code:
>
>  The code implementing a gpio_chip should support multiple instances of the
>  controller, preferably using the driver model. That code will configure each
> -gpio_chip and issue ``gpiochip_add[_data]()`` or ``devm_gpiochip_add_data()``.
> -Removing a GPIO controller should be rare; use ``[devm_]gpiochip_remove()``
> -when it is unavoidable.
> +gpio_chip and issue gpiochip_add(), gpiochip_add_data(), or
> +devm_gpiochip_add_data().  Removing a GPIO controller should be rare; use
> +gpiochip_remove() when it is unavoidable.
>
>  Often a gpio_chip is part of an instance-specific structure with states not
>  exposed by the GPIO interfaces, such as addressing, power management, and more.
> @@ -418,11 +418,11 @@ symbol:
>
>  If there is a need to exclude certain GPIO lines from the IRQ domain handled by
>  these helpers, we can set .irq.need_valid_mask of the gpiochip before
> -``[devm_]gpiochip_add_data()`` is called. This allocates an .irq.valid_mask with as
> -many bits set as there are GPIO lines in the chip, each bit representing line
> -0..n-1. Drivers can exclude GPIO lines by clearing bits from this mask. The mask
> -must be filled in before gpiochip_irqchip_add() or gpiochip_irqchip_add_nested()
> -is called.
> +devm_gpiochip_add_data() or gpiochip_add_data() is called. This allocates an
> +.irq.valid_mask with as many bits set as there are GPIO lines in the chip, each
> +bit representing line 0..n-1. Drivers can exclude GPIO lines by clearing bits
> +from this mask. The mask must be filled in before gpiochip_irqchip_add() or
> +gpiochip_irqchip_add_nested() is called.
>
>  To use the helpers please keep the following in mind:
>
> --
> 2.21.0
>

Patch applied, thanks!

Bartosz