doc: fix link to AF XDP PMD in CNI howto
Checks
Commit Message
Having an explicit link to the main repository documentation breaks
other repositories documentation (like for LTS releases).
Fixes: 7fc6ae50369d ("net/af_xdp: support CNI Integration")
Cc: stable@dpdk.org
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
doc/guides/howto/af_xdp_cni.rst | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
Comments
On Wed, Jun 21, 2023 at 11:57:18AM +0200, David Marchand wrote:
> Having an explicit link to the main repository documentation breaks
> other repositories documentation (like for LTS releases).
>
> Fixes: 7fc6ae50369d ("net/af_xdp: support CNI Integration")
> Cc: stable@dpdk.org
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
21/06/2023 12:52, Bruce Richardson:
> On Wed, Jun 21, 2023 at 11:57:18AM +0200, David Marchand wrote:
> > Having an explicit link to the main repository documentation breaks
> > other repositories documentation (like for LTS releases).
> >
> > Fixes: 7fc6ae50369d ("net/af_xdp: support CNI Integration")
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Applied, thanks.
@@ -14,7 +14,7 @@ AF_XDP is a Linux socket Address Family that enables an XDP program
to redirect packets to a memory buffer in userspace.
This document explains how to enable the `AF_XDP Plugin for Kubernetes`_ within
-a DPDK application using the `AF_XDP PMD`_ to connect and use these technologies.
+a DPDK application using the :doc:`../nics/af_xdp` to connect and use these technologies.
.. _AF_XDP Plugin for Kubernetes: https://github.com/intel/afxdp-plugins-for-kubernetes
@@ -22,7 +22,7 @@ a DPDK application using the `AF_XDP PMD`_ to connect and use these technologies
Background
----------
-The standard `AF_XDP PMD`_ initialization process involves loading an eBPF program
+The standard :doc:`../nics/af_xdp` initialization process involves loading an eBPF program
onto the kernel netdev to be used by the PMD.
This operation requires root or escalated Linux privileges
and thus prevents the PMD from working in an unprivileged container.
@@ -47,8 +47,6 @@ should be used when creating the socket
to instruct libbpf not to load the default libbpf program on the netdev.
Instead the loading is handled by the CNI.
-.. _AF_XDP PMD: https://doc.dpdk.org/guides/nics/af_xdp.html
-
.. note::
The Unix Domain Socket file path appear in the end user is "/tmp/afxdp.sock".