1
0
Fork 0
mirror of synced 2025-03-06 20:59:54 +01:00
Commit graph

11 commits

Author SHA1 Message Date
Andy Shevchenko
447e140e66 gpio: Remove legacy API documentation
In order to discourage people to use old and legacy GPIO APIs
remove the respective documentation completely. It also helps
further cleanups of the legacy GPIO API leftovers, which is
ongoing task.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Hu Haowen <2023002089@link.tyut.edu.cn>
Link: https://lore.kernel.org/r/20240508101703.830066-1-andriy.shevchenko@linux.intel.com
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
2024-05-27 16:50:03 +02:00
Linus Walleij
ddb4e53fc7 gpio: Add use guidance documentation
The text in this new document is a response to recurring questions
about the GPIO in-kernel API vs the userspace ABI. When do you use
one or the other? It can be a bit intuitive, but I tried to sum it
all up.

Reviewed-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
Link: https://lore.kernel.org/r/20200108001712.47500-1-linus.walleij@linaro.org
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2020-01-15 11:11:43 +01:00
Jonathan Neuschäfer
5f07224e0f docs: driver-api: Move bt8xxgpio to the gpio directory
Let's declutter Documentation/driver-api a bit.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20191004164059.10397-1-j.neuschaefer@gmx.net
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2019-10-09 11:12:33 +02:00
Randy Dunlap
7a42781eee gpio: fix kernel-doc after devres.c file rename
Fix gpio kernel-doc generation after rename of the devres.c file.
Fixes these errors & warning:

Error: Cannot open file ../drivers/gpio/devres.c
Error: Cannot open file ../drivers/gpio/devres.c
WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno -export ../drivers/gpio/devres.c' failed with return code 2

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-10-10 13:49:15 +02:00
Jonathan Neuschäfer
4784e710b1 Documentation: gpio: Move drivers-on-gpio.txt to driver-api
Move gpio/drivers-on-gpio.txt to driver-api/gpio/drivers-on-gpio.rst and
make sure it builds cleanly as ReST.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-23 04:22:29 +01:00
Jonathan Neuschäfer
6960341aa3 Documentation: gpio: Move GPIO mapping documentation to driver-api
Move gpio/board.txt to driver-api/gpio/board.rst and make sure it builds
cleanly as ReST.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-23 04:22:04 +01:00
Jonathan Neuschäfer
4e0edc4b3f Documentation: gpio: Move gpiod_* consumer documentation to driver-api
Move gpio/consumer.txt to driver-api/gpio/consumer.rst and make sure it
builds cleanly as ReST.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-23 04:21:40 +01:00
Jonathan Neuschäfer
7ee2c13080 Documentation: gpio: Move legacy documentation to driver-api
Move gpio/gpio-legacy.txt to driver-api/gpio/legacy.rst and make sure it
builds cleanly as ReST.

Also move the legacy API reference from index.rst to legacy.rst.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-23 04:21:16 +01:00
Jonathan Neuschäfer
778ea833c5 Documentation: gpio: Move driver documentation to driver-api
Move gpio/driver.txt to driver-api/gpio/driver.rst and make sure it
builds cleanly as ReST.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-23 04:20:54 +01:00
Jonathan Neuschäfer
02bf219d2f Documentation: gpio: Move introduction to driver-api
Move gpio/intro.txt to driver-api/gpio/intro.rst and make sure it builds
cleanly as ReST.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-23 04:20:30 +01:00
Jonathan Neuschäfer
7e6332592b Documentation: driver-api: Move gpio.rst to gpio/index.rst
To make space for more files in the GPIO section, create a
Documentation/driver-api/gpio/ directory.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-23 04:20:08 +01:00
Renamed from Documentation/driver-api/gpio.rst (Browse further)