[v2,1/8] doc/linux_gsg: add driver guides to document list

Message ID 20220310123843.612207-2-bruce.richardson@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series Linux GSG doc updates |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-testing warning apply patch failure

Commit Message

Bruce Richardson March 10, 2022, 12:38 p.m. UTC
  The document roadmap section was missing any mention of the individual
drivers guides which are important for users. Add them to list.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/linux_gsg/intro.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
  

Patch

diff --git a/doc/guides/linux_gsg/intro.rst b/doc/guides/linux_gsg/intro.rst
index 890169e97f..ea98ac7425 100644
--- a/doc/guides/linux_gsg/intro.rst
+++ b/doc/guides/linux_gsg/intro.rst
@@ -34,3 +34,28 @@  The following is a list of DPDK documents in the suggested reading order:
 
 *   Sample Applications User Guide: Describes a set of sample applications.
     Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application.
+
+*   Driver Reference Guides: Provides details on each driver inside a particular category.
+    Separate guides exist for each of:
+
+    * Baseband devices
+
+    * Compression devices
+
+    * Cryptographic accelerator devices
+
+    * DMA devices
+
+    * Event-based scheduling devices
+
+    * General purpose GPU devices
+
+    * Mempool drivers
+
+    * Network (NIC) devices
+
+    * "Raw" devices i.e. those not fitting into any other category
+
+    * Regular expression devices
+
+    * vDPA (vhost data path acceleration) devices
\ No newline at end of file