[PATCH] Updated to dpdk20.11

[PATCH] Updated to dpdk20.11

[David Young]

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

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`.
+
-- 
2.41.0.windows.1

Re: [PATCH] Updated to dpdk20.11

[Aaron Conole]

Hi David,

David Young <dave@youngcopy.com> writes:

> ---

Thanks for the contribution!  Very happy to have someone working on the
docs.  Thanks for getting a patch to the mailing list.  Just a few
nits to address before the patch can get merged.

Customarily, a change to each area will describe that in the subject -
ie:

  docs: freebsd: Update to 20.11

Then in the message body, we can add a bit extra detailing why the
change was needed:

  The docs were specifying to install the dpdk package, but this is
  ambiguous/didn't work/blah blah blah...

Finally, just before the end, we add a DCO sign-off tag:

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

When replying for a v2, v3, etc., you will need to reply to the most
recent version which was obsoleted (in this case, git send-email \
--in-reply-to="<20230629181209.400-1-dave@youngcopy.com>") and make sure
that the [PATCH] metadata line includes the text v2.

Thanks!

>  doc/guides/freebsd_gsg/install_from_ports.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> 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`.
> +

[PATCH v2] docs: freebsd: Update to 20.11

[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.


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

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

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`.
+
-- 
2.41.0.windows.1

Re: [PATCH v2] docs: freebsd: Update to 20.11

[Thomas Monjalon]

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.

[PATCH v3] docs: freebsd: Update to 20.11

[David Young]

This patch updates the FreeBSD DPDK installation guide to detail
how users can find and install specific versions of DPDK using the
pkg package manager. The prior instructions did not highlight 
'dpdk' is an alias and may not always point to the latest DPDK 
version. The guide now includes steps to search for available DPDK versions
with pkg search dpdk, select a desired version, and install that 
version explicitly with pkg install <package-name>. The <package-name>
should be replaced with the specific DPDK version, like dpdk20.11.8. 
The document includes a reminder to regularly update repositories using
pkg update to maintain access to the most recent DPDK versions.


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

---
 doc/guides/freebsd_gsg/install_from_ports.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/guides/freebsd_gsg/install_from_ports.rst b/doc/guides/freebsd_gsg/install_from_ports.rst
index cc251dd359..b6c1e1306e 100644
--- a/doc/guides/freebsd_gsg/install_from_ports.rst
+++ b/doc/guides/freebsd_gsg/install_from_ports.rst
@@ -33,7 +33,9 @@ To install a specific version of DPDK, use the `pkg install` command, followed b
 
 Replace `<package-name>` with the name of the DPDK package you want to install. For example, if you want to install version `dpdk20.11.8`, replace `<package-name>` with `dpdk20.11.8`.
 
-Remember to update your repositories regularly with `pkg update` so you have access to the latest versions.
+.. note::
+
+   Remember to update your repositories regularly with `pkg update` so you have access to the latest versions.
 
 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
-- 
2.41.0.windows.1

Re: [PATCH v2] docs: freebsd: Update to 20.11

[Bruce Richardson]

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