[v3,02/17] doc: initial commit for dmadevs section

Message ID 20210908103016.1661914-3-kevin.laatz@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series add dmadev driver for idxd devices |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Kevin Laatz Sept. 8, 2021, 10:30 a.m. UTC
  Add new section to the programmer's guide for dmadev devices.

Signed-off-by: Kevin Laatz <kevin.laatz@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/dmadevs/index.rst | 14 ++++++++++++++
 doc/guides/index.rst         |  1 +
 2 files changed, 15 insertions(+)
 create mode 100644 doc/guides/dmadevs/index.rst
  

Comments

Conor Walsh Sept. 8, 2021, 4 p.m. UTC | #1
> Add new section to the programmer's guide for dmadev devices.
>
> Signed-off-by: Kevin Laatz <kevin.laatz@intel.com>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Reviewed-by: Conor Walsh <conor.walsh@intel.com>

<snip>
  

Patch

diff --git a/doc/guides/dmadevs/index.rst b/doc/guides/dmadevs/index.rst
new file mode 100644
index 0000000000..b30004fd65
--- /dev/null
+++ b/doc/guides/dmadevs/index.rst
@@ -0,0 +1,14 @@ 
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2021 Intel Corporation.
+
+DMA Device Drivers
+==================
+
+The following are a list of DMA device PMDs, which can be used from an
+application through DMAdev API.
+
+.. toctree::
+    :maxdepth: 2
+    :numbered:
+
+    idxd
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 857f0363d3..ccb71640dd 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -19,6 +19,7 @@  DPDK documentation
    bbdevs/index
    cryptodevs/index
    compressdevs/index
+   dmadevs/index
    vdpadevs/index
    regexdevs/index
    eventdevs/index