[4/4] doc: add driver guides to document list in Linux GSG

Message ID 20220315220504.1092437-5-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series Update doc lists in GSG intros |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/iol-abi-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-broadcom-Functional fail Functional Testing issues

Commit Message

Bruce Richardson March 15, 2022, 10:05 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 20fe4de630..1b81df8a0f 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:
 
 *   :doc:`../sample_app_ug/index`: 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:
+
+    * :doc:`../bbdevs/index`
+
+    * :doc:`../compressdevs/index`
+
+    * :doc:`../cryptodevs/index`
+
+    * :doc:`../dmadevs/index`
+
+    * :doc:`../eventdevs/index`
+
+    * :doc:`../gpus/index`
+
+    * :doc:`../mempool/index`
+
+    * :doc:`../nics/index`
+
+    * :doc:`../rawdevs/index`
+
+    * :doc:`../regexdevs/index`
+
+    * :doc:`../vdpadevs/index`