linux-gpio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Thierry Reding <thierry.reding@gmail.com>
To: Linus Walleij <linus.walleij@linaro.org>
Cc: Mika Westerberg <mika.westerberg@linux.intel.com>,
	Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-gpio@vger.kernel.org, linux-acpi@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH 6/7] docs: driver-api: Add GPIO section
Date: Mon, 24 Jul 2017 16:57:27 +0200	[thread overview]
Message-ID: <20170724145728.7662-6-thierry.reding@gmail.com> (raw)
In-Reply-To: <20170724145728.7662-1-thierry.reding@gmail.com>

From: Thierry Reding <treding@nvidia.com>

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 <treding@nvidia.com>
---
 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

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
-- 
2.13.3


  parent reply	other threads:[~2017-07-24 14:57 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-24 14:57 [PATCH 1/7] gpio: Cleanup kerneldoc Thierry Reding
2017-07-24 14:57 ` [PATCH 2/7] gpio: of: Improve kerneldoc Thierry Reding
2017-08-02 12:07   ` Linus Walleij
2017-07-24 14:57 ` [PATCH 3/7] gpio: devres: " Thierry Reding
2017-08-02 12:07   ` Linus Walleij
2017-07-24 14:57 ` [PATCH 4/7] gpio: acpi: Fixup kerneldoc Thierry Reding
2017-07-24 15:13   ` Andy Shevchenko
2017-07-25  8:50     ` Mika Westerberg
2017-08-02 12:09   ` Linus Walleij
2017-07-24 14:57 ` [PATCH 5/7] gpio: sysfs: " Thierry Reding
2017-08-02 12:10   ` Linus Walleij
2017-07-24 14:57 ` Thierry Reding [this message]
2017-08-02 12:13   ` [PATCH 6/7] docs: driver-api: Add GPIO section Linus Walleij
2017-07-24 14:57 ` [PATCH 7/7] gpio: Use unsigned int for of_gpio_n_cells Thierry Reding
2017-08-02 12:14   ` Linus Walleij
2017-07-31 11:02 ` [PATCH 1/7] gpio: Cleanup kerneldoc Thierry Reding
2017-08-02 12:04   ` Linus Walleij
2017-08-02 12:06 ` Linus Walleij

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170724145728.7662-6-thierry.reding@gmail.com \
    --to=thierry.reding@gmail.com \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=linus.walleij@linaro.org \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mika.westerberg@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).