diff mbox series

doc: fix link to AF XDP PMD in CNI howto

Message ID 20230621095718.1625888-1-david.marchand@redhat.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: fix link to AF XDP PMD in CNI howto |

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/intel-Functional success Functional PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/github-robot: build fail github build: failed
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

David Marchand June 21, 2023, 9:57 a.m. UTC 
  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

Bruce Richardson June 21, 2023, 10:52 a.m. UTC | #1 
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>
Thomas Monjalon July 20, 2023, 4:23 a.m. UTC | #2 
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.
diff mbox series

Patch

diff --git a/doc/guides/howto/af_xdp_cni.rst b/doc/guides/howto/af_xdp_cni.rst
index a38f02450e..a1a6d5b99c 100644
--- a/doc/guides/howto/af_xdp_cni.rst
+++ b/doc/guides/howto/af_xdp_cni.rst
@@ -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".