UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

Documentation: gpio: fix function links in the HTML docs 

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 48207d7595 ("gpio:
drop devm_gpiochip_remove()").

Signed-off-by: Jeremy Cline <jcline@redhat.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
This commit is contained in:
Jeremy Cline 2019-07-29 10:37:30 -04:00 committed by Bartosz Golaszewski
parent 9091373ab7
commit d9e5ebac18
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/driver-api/gpio/driver.rst
View File

@ -69,9 +69,9 @@ driver code:
The code implementing a gpio_chip should support multiple instances of the The code implementing a gpio_chip should support multiple instances of the
controller, preferably using the driver model. That code will configure each controller, preferably using the driver model. That code will configure each
gpio_chip and issue ``gpiochip_add[_data]()`` or ``devm_gpiochip_add_data()``. gpio_chip and issue gpiochip_add(), gpiochip_add_data(), or
Removing a GPIO controller should be rare; use ``[devm_]gpiochip_remove()`` devm_gpiochip_add_data(). Removing a GPIO controller should be rare; use
when it is unavoidable. gpiochip_remove() when it is unavoidable.
Often a gpio_chip is part of an instance-specific structure with states not 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. 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 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 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 devm_gpiochip_add_data() or gpiochip_add_data() is called. This allocates an
many bits set as there are GPIO lines in the chip, each bit representing line .irq.valid_mask with as many bits set as there are GPIO lines in the chip, each
0..n-1. Drivers can exclude GPIO lines by clearing bits from this mask. The mask bit representing line 0..n-1. Drivers can exclude GPIO lines by clearing bits
must be filled in before gpiochip_irqchip_add() or gpiochip_irqchip_add_nested() from this mask. The mask must be filled in before gpiochip_irqchip_add() or
is called. gpiochip_irqchip_add_nested() is called.
To use the helpers please keep the following in mind: To use the helpers please keep the following in mind: