[v2] docs: freebsd: Update to 20.11

Message ID 20230630164146.1378-1-dave@youngcopy.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] docs: freebsd: Update to 20.11 |

Checks

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

Commit Message

Dave Young June 30, 2023, 4:41 p.m. UTC
  This patch updates the installation instructions for DPDK on FreeBSD.
It specifies the explicit version of DPDK (20.11) to be installed.
This change is important as the 'dpdk' package is an alias and doesn't
always point to the latest version. By specifying the explicit version,
we make it clear which version is to be installed. The page previously
showed 'pkg install dpdk' without specifying the version.


Signed-off-by: David Young <dave@youngcopy.com>

---
 doc/guides/freebsd_gsg/install_from_ports.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
  

Comments

Thomas Monjalon July 3, 2023, 3:19 p.m. UTC | #1
30/06/2023 18:41, David Young:
> This patch updates the installation instructions for DPDK on FreeBSD.
> It specifies the explicit version of DPDK (20.11) to be installed.
> This change is important as the 'dpdk' package is an alias and doesn't
> always point to the latest version. By specifying the explicit version,
> we make it clear which version is to be installed. The page previously
> showed 'pkg install dpdk' without specifying the version.

I understand it can be helpful to choose a specific version.
But dpdk20.11 is not necessarily the latest one,
and it could be useful to show both approaches in the doc.

> @@ -123,3 +123,4 @@ via the contigmem module, and 4 NIC ports bound to the nic_uio module::
>  
>     For an explanation of the command-line parameters that can be passed to an
>     DPDK application, see section :ref:`running_sample_app`.
> +

This last line looks like an extra unnneeded blank line.
  
Bruce Richardson July 17, 2023, 1:35 p.m. UTC | #2
On Mon, Jul 03, 2023 at 05:19:18PM +0200, Thomas Monjalon wrote:
> 30/06/2023 18:41, David Young:
> > This patch updates the installation instructions for DPDK on FreeBSD.
> > It specifies the explicit version of DPDK (20.11) to be installed.
> > This change is important as the 'dpdk' package is an alias and doesn't
> > always point to the latest version. By specifying the explicit version,
> > we make it clear which version is to be installed. The page previously
> > showed 'pkg install dpdk' without specifying the version.
> 
> I understand it can be helpful to choose a specific version.
> But dpdk20.11 is not necessarily the latest one,
> and it could be useful to show both approaches in the doc.
> 

The FreeBSD ports don't always track the latest DPDK LTS sadly. Originally
I used to just update the existing "dpdk" port to the latest version each
release, but with the API policy and LTS compatibility guarantees, we now
need separate per-LTS DPDK packages. The old "dpdk" package is 19.11 and I
have a patch submitted to mark it as deprecated and add a new "dpdk22.11"
package instead to replace it [never did do 21.11 - two ports to manage is
easier for me that 3!]. The patch is undergoing review from the ports team,
and I have still to rework based on the feedback.

Therefore, I think the docs should just cover using "pkg search" to find
DPDK port packages, and recommending selecting the latest one.

/Bruce
  

Patch

diff --git a/doc/guides/freebsd_gsg/install_from_ports.rst b/doc/guides/freebsd_gsg/install_from_ports.rst
index d946f3f3b2..ae866cd879 100644
--- a/doc/guides/freebsd_gsg/install_from_ports.rst
+++ b/doc/guides/freebsd_gsg/install_from_ports.rst
@@ -23,7 +23,7 @@  Installing the DPDK Package for FreeBSD
 
 DPDK can be installed on FreeBSD using the command::
 
-	pkg install dpdk
+	pkg install dpdk20.11
 
 After the installation of the DPDK package, instructions will be printed on
 how to install the kernel modules required to use the DPDK. A more
@@ -51,7 +51,7 @@  a pre-compiled binary package.
 On a system with the ports collection installed in ``/usr/ports``, the DPDK
 can be installed using the commands::
 
-    cd /usr/ports/net/dpdk
+    cd /usr/ports/net/dpdk20.11
 
     make install
 
@@ -123,3 +123,4 @@  via the contigmem module, and 4 NIC ports bound to the nic_uio module::
 
    For an explanation of the command-line parameters that can be passed to an
    DPDK application, see section :ref:`running_sample_app`.
+