Skip to content

Commit

Permalink
Documentation: gpio: Move introduction to driver-api
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Jonathan Neuschäfer authored and Linus Walleij committed Mar 23, 2018
1 parent 7e63325 commit 02bf219
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
7 changes: 7 additions & 0 deletions Documentation/driver-api/gpio/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
General Purpose Input/Output (GPIO)
===================================

Contents:

.. toctree::
:maxdepth: 2

intro

Core
====

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
============
Introduction
============


GPIO Interfaces
===============

Expand All @@ -9,9 +14,9 @@ Due to the history of GPIO interfaces in the kernel, there are two different
ways to obtain and use GPIOs:

- The descriptor-based interface is the preferred way to manipulate GPIOs,
and is described by all the files in this directory excepted gpio-legacy.txt.
and is described by all the files in this directory excepted gpio-legacy.txt.
- The legacy integer-based interface which is considered deprecated (but still
usable for compatibility reasons) is documented in gpio-legacy.txt.
usable for compatibility reasons) is documented in gpio-legacy.txt.

The remainder of this document applies to the new descriptor-based interface.
gpio-legacy.txt contains the same information applied to the legacy
Expand Down
2 changes: 0 additions & 2 deletions Documentation/gpio/00-INDEX
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
00-INDEX
- This file
gpio.txt
- Introduction to GPIOs and their kernel interfaces
consumer.txt
- How to obtain and use GPIOs in a driver
driver.txt
Expand Down

0 comments on commit 02bf219

Please sign in to comment.