dmaengine: doc: Add ReST style dmaengine document
authorVinod Koul <vinod.koul@intel.com>
Fri, 3 Nov 2017 04:49:37 +0000 (10:19 +0530)
committerJonathan Corbet <corbet@lwn.net>
Sun, 5 Nov 2017 17:03:19 +0000 (10:03 -0700)
This removes the index file and adds the index.rst as placeholder
and update driver-api index to add dmaengine. As a consequence
dmaengine documentation will be in driver-api/

Signed-off-by: Vinod Koul <vinod.koul@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/dmaengine/00-INDEX [deleted file]
Documentation/driver-api/dmaengine/index.rst [new file with mode: 0644]
Documentation/driver-api/index.rst

diff --git a/Documentation/dmaengine/00-INDEX b/Documentation/dmaengine/00-INDEX
deleted file mode 100644 (file)
index 07de657..0000000
+++ /dev/null
@@ -1,8 +0,0 @@
-00-INDEX
-       - this file.
-client.txt
-       -the DMA Engine API Guide.
-dmatest.txt
-       - how to compile, configure and use the dmatest system.
-provider.txt
-       - the DMA controller API.
\ No newline at end of file
diff --git a/Documentation/driver-api/dmaengine/index.rst b/Documentation/driver-api/dmaengine/index.rst
new file mode 100644 (file)
index 0000000..8c90a64
--- /dev/null
@@ -0,0 +1,13 @@
+=======================
+DMAEngine documentation
+=======================
+
+DMAEngine documentation provides documents for various aspects of DMAEngine
+framework.
+
+.. only::  subproject
+
+   Indices
+   =======
+
+   * :ref:`genindex`
index 9c20624..d17a987 100644 (file)
@@ -46,6 +46,7 @@ available subsections can be seen below.
    pinctl
    gpio
    misc_devices
+   dmaengine/index
 
 .. only::  subproject and html