[PATCH 1/2] doc/freebsd_gsg: add driver guides to document list

[PATCH 1/2] doc/freebsd_gsg: add driver guides to document list

[Bruce Richardson]

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(+)

diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst
index b2e57909ee..09afafea56 100644
--- a/doc/guides/freebsd_gsg/intro.rst
+++ b/doc/guides/freebsd_gsg/intro.rst
@@ -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
-- 
2.32.0

[PATCH 2/2] doc/freebsd_gsg: update DPDK build section

[Bruce Richardson]

Some minor updates for the section on builing DPDK in the GSG:

* update Python 3.7 package name to the 3.8 version
* note that the pyelftools needs to be tied to the python version
* drop reference to jansson library for legacy telemetry
* replace special characters for (R)

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/freebsd_gsg/build_dpdk.rst | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/doc/guides/freebsd_gsg/build_dpdk.rst b/doc/guides/freebsd_gsg/build_dpdk.rst
index bed353473f..d335b97cfc 100644
--- a/doc/guides/freebsd_gsg/build_dpdk.rst
+++ b/doc/guides/freebsd_gsg/build_dpdk.rst
@@ -1,6 +1,8 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
+.. include:: <isonum.txt>
+
 .. _building_from_source:
 
 Compiling the DPDK Target from Source
@@ -14,11 +16,16 @@ The following FreeBSD packages are required to build DPDK:
 * meson
 * ninja
 * pkgconf
-* py37-pyelftools
+* py38-pyelftools
+
+.. note:
+
+  The specific package for pyelftools is dependent on the version of python in use,
+  Python 3.8 being the version at type of writing, hence the ``py38`` prefix.
 
 These can be installed using (as root)::
 
-  pkg install meson pkgconf py37-pyelftools
+  pkg install meson pkgconf py38-pyelftools
 
 To compile the required kernel modules for memory management and working
 with physical NIC devices, the kernel sources for FreeBSD also
@@ -28,11 +35,6 @@ installed via commands like the following, for FreeBSD 12.1 on x86_64::
   fetch http://ftp.freebsd.org/pub/FreeBSD/releases/amd64/12.1-RELEASE/src.txz
   tar -C / -xJvf src.txz
 
-To enable the telemetry library in DPDK, the jansson library also needs to
-be installed, and can be installed via::
-
-  pkg install jansson
-
 Individual drivers may have additional requirements. Consult the relevant
 driver guide for any driver-specific requirements of interest.
 
@@ -176,7 +178,7 @@ Binding Network Ports to the nic_uio Module
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Device ownership can be viewed using the pciconf -l command. The example below shows
-four Intel® 82599 network ports under ``if_ixgbe`` module ownership.
+four Intel\ |reg| 82599 network ports under ``if_ixgbe`` module ownership.
 
 .. code-block:: none
 
-- 
2.32.0

Re: [PATCH 1/2] doc/freebsd_gsg: add driver guides to document list

[Thomas Monjalon]

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

Re: [PATCH 1/2] doc/freebsd_gsg: add driver guides to document list

[Bruce Richardson]

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

Re: [PATCH 2/2] doc/freebsd_gsg: update DPDK build section

[Thomas Monjalon]

11/03/2022 21:07, Bruce Richardson:
> Some minor updates for the section on builing DPDK in the GSG:
> 
> * update Python 3.7 package name to the 3.8 version
> * note that the pyelftools needs to be tied to the python version
> * drop reference to jansson library for legacy telemetry
> * replace special characters for (R)
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Applied only this second patch, thanks.