diff mbox

[1/5] dmaengine: doc: Add ReST style dmaengine document

Message ID 1508913176-812-2-git-send-email-vinod.koul@intel.com (mailing list archive)
State Changes Requested
Headers show

Commit Message

Vinod Koul Oct. 25, 2017, 6:32 a.m. UTC 
This removes the index file and adds the index.rst as placeholder and update
top index to add dmaengine

Signed-off-by: Vinod Koul <vinod.koul@intel.com>
---
 Documentation/dmaengine/00-INDEX  |  8 --------
 Documentation/dmaengine/index.rst | 13 +++++++++++++
 Documentation/index.rst           |  1 +
 3 files changed, 14 insertions(+), 8 deletions(-)
 delete mode 100644 Documentation/dmaengine/00-INDEX
 create mode 100644 Documentation/dmaengine/index.rst
diff mbox

Patch

diff --git a/Documentation/dmaengine/00-INDEX b/Documentation/dmaengine/00-INDEX
deleted file mode 100644
index 07de6573d22b..000000000000
--- a/Documentation/dmaengine/00-INDEX
+++ /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/dmaengine/index.rst b/Documentation/dmaengine/index.rst
new file mode 100644
index 000000000000..8c90a6443810
--- /dev/null
+++ b/Documentation/dmaengine/index.rst
@@ -0,0 +1,13 @@ 
+=======================
+DMAEngine documentation
+=======================
+
+DMAEngine documentation provides documents for various aspects of DMAEngine
+framework.
+
+.. only::  subproject
+
+   Indices
+   =======
+
+   * :ref:`genindex`
diff --git a/Documentation/index.rst b/Documentation/index.rst
index cb7f1ba5b3b1..f44c503859b5 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -75,6 +75,7 @@  needed).
    sound/index
    crypto/index
    filesystems/index
+   dmaengine/index
 
 Architecture-specific documentation
 -----------------------------------