Documentation: gpio: Move introduction to driver-api
authorJonathan Neuschäfer <j.neuschaefer@gmx.net>
Thu, 8 Mar 2018 23:40:19 +0000 (00:40 +0100)
committerLinus Walleij <linus.walleij@linaro.org>
Fri, 23 Mar 2018 03:20:30 +0000 (04:20 +0100)
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>
Documentation/driver-api/gpio/index.rst
Documentation/driver-api/gpio/intro.rst [moved from Documentation/gpio/gpio.txt with 96% similarity]
Documentation/gpio/00-INDEX

index 6dd4aa6..db47d84 100644 (file)
@@ -2,6 +2,13 @@
 General Purpose Input/Output (GPIO)
 ===================================
 
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   intro
+
 Core
 ====
 
similarity index 96%
rename from Documentation/gpio/gpio.txt
rename to Documentation/driver-api/gpio/intro.rst
index cd9b356..7459148 100644 (file)
@@ -1,3 +1,8 @@
+============
+Introduction
+============
+
+
 GPIO Interfaces
 ===============
 
@@ -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
index 179beb2..52fe0fa 100644 (file)
@@ -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