From: Bruce Richardson Date: Fri, 11 Mar 2022 20:07:52 +0000 (+0000) Subject: doc: update build section of FreeBSD guide X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=9e6f75e259a829d4393c0f63a77778424c4be064;p=dpdk.git doc: update build section of FreeBSD guide 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 --- 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:: + .. _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