[6/7] docs: driver-api: Add GPIO section

Commit Message

Thierry Reding July 24, 2017, 2:57 p.m. UTC

From: Thierry Reding <[e-mail]>

This adds a section about the various parts of the GPIO subsystem to the
driver API documentation. Note that this isn't exhaustive documentation,
but rather focusses on pulling in the kerneldoc from various sources, in
order to improve coverage of kerneldoc processing.

Signed-off-by: Thierry Reding <[e-mail]>
---
 Documentation/driver-api/gpio.rst  | 45 ++++++++++++++++++++++++++++++++++++++
 Documentation/driver-api/index.rst |  1 +
 2 files changed, 46 insertions(+)
 create mode 100644 Documentation/driver-api/gpio.rst

Comments

Linus Walleij Aug. 2, 2017, 12:13 p.m. UTC | #1

On Mon, Jul 24, 2017 at 4:57 PM, Thierry Reding
<[e-mail]> wrote:

> From: Thierry Reding <[e-mail]>
>
> This adds a section about the various parts of the GPIO subsystem to the
> driver API documentation. Note that this isn't exhaustive documentation,
> but rather focusses on pulling in the kerneldoc from various sources, in
> order to improve coverage of kerneldoc processing.
>
> Signed-off-by: Thierry Reding <[e-mail]>

Patch applied, but...

> +sysfs helpers
> +=============
> +
> +.. kernel-doc:: drivers/gpio/gpiolib-sysfs.c
> +   :export:

I don't know about this. That is the legacy ABI, I am thinking about hiding
it so as not to encourage it. Yet the code is definately there, sigh.

Yours,
Linus Walleij
--
To unsubscribe from this list: send the line "unsubscribe linux-acpi" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/Documentation/driver-api/gpio.rst b/Documentation/driver-api/gpio.rst
new file mode 100644
index 000000000000..6dd4aa647f27
--- /dev/null
+++ b/Documentation/driver-api/gpio.rst
@@ -0,0 +1,45 @@ 
+===================================
+General Purpose Input/Output (GPIO)
+===================================
+
+Core
+====
+
+.. kernel-doc:: include/linux/gpio/driver.h
+   :internal:
+
+.. kernel-doc:: drivers/gpio/gpiolib.c
+   :export:
+
+Legacy API
+==========
+
+The functions listed in this section are deprecated. The GPIO descriptor based
+API described above should be used in new code.
+
+.. kernel-doc:: drivers/gpio/gpiolib-legacy.c
+   :export:
+
+ACPI support
+============
+
+.. kernel-doc:: drivers/gpio/gpiolib-acpi.c
+   :export:
+
+Device tree support
+===================
+
+.. kernel-doc:: drivers/gpio/gpiolib-of.c
+   :export:
+
+Device-managed API
+==================
+
+.. kernel-doc:: drivers/gpio/devres.c
+   :export:
+
+sysfs helpers
+=============
+
+.. kernel-doc:: drivers/gpio/gpiolib-sysfs.c
+   :export:
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 7c94ab50afed..9c20624842b7 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -44,6 +44,7 @@  available subsections can be seen below.
    uio-howto
    firmware/index
    pinctl
+   gpio
    misc_devices
 
 .. only::  subproject and html