diff mbox series

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

Message ID 20220311200752.1020202-2-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [1/2] doc/freebsd_gsg: add driver guides to document list |

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/github-robot: build success github build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional 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-abi-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS

Commit Message

Bruce Richardson March 11, 2022, 8:07 p.m. UTC 
  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(-)

Comments

Thomas Monjalon March 15, 2022, 4:57 p.m. UTC | #1 
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.
diff mbox series

Patch

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