[1/2] doc/freebsd_gsg: add driver guides to document list
Checks
Commit Message
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/freebsd_gsg/intro.rst | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
Comments
11/03/2022 21:07, Bruce Richardson:
> The document roadmap section was missing any mention of the individual
> drivers guides which are important for users. Add them to list.
It would be more useful if being links.
You can use the syntax :doc: to link to the start of a doc.
> +* **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
On Tue, Mar 15, 2022 at 05:46:38PM +0100, Thomas Monjalon wrote:
> 11/03/2022 21:07, Bruce Richardson:
> > The document roadmap section was missing any mention of the individual
> > drivers guides which are important for users. Add them to list.
>
> It would be more useful if being links.
> You can use the syntax :doc: to link to the start of a doc.
>
Yes. However, existing references on the page are not links, so I added
these in the same style for consistency.
I'll try and get to do a V2 and see about making these all links.
/Bruce
@@ -53,3 +53,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