From: David Marchand <david.marchand@redhat.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net, stable@dpdk.org,
Shibin Koikkara Reeny <shibin.koikkara.reeny@intel.com>,
Qi Zhang <qi.z.zhang@intel.com>,
Ferruh Yigit <ferruh.yigit@amd.com>,
John McNamara <john.mcnamara@intel.com>
Subject: [PATCH] doc: fix link to AF XDP PMD in CNI howto
Date: Wed, 21 Jun 2023 11:57:18 +0200 [thread overview]
Message-ID: <20230621095718.1625888-1-david.marchand@redhat.com> (raw)
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(-)
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".
--
2.40.1
next reply other threads:[~2023-06-21 9:57 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-21 9:57 David Marchand [this message]
2023-06-21 10:52 ` Bruce Richardson
2023-07-20 4:23 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230621095718.1625888-1-david.marchand@redhat.com \
--to=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@amd.com \
--cc=john.mcnamara@intel.com \
--cc=qi.z.zhang@intel.com \
--cc=shibin.koikkara.reeny@intel.com \
--cc=stable@dpdk.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).