From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E77BC42D12; Wed, 21 Jun 2023 11:57:30 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AB8B641138; Wed, 21 Jun 2023 11:57:30 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id B368C4003C for ; Wed, 21 Jun 2023 11:57:28 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1687341448; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=4wwIjjJp8CKSwAJF5Cs5hnvo3hqFPbmFhVjwjRJvfnw=; b=b71hwzxY2uo9p0629wRSwS4Jt5HGGIx+6xuNYgXo5U5Dy7GTzSE4+zxkeohQcXQ90PajmA 7o718znXux6ASnRxlXVS4M0fhSN1RSXgtdM24+c8xV1CGFpfwFal3QEas/87Ayj/600QI0 DmFIOYP6FwOK2dQ42CwlPGbGdqa7Y/w= Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-455-V7UcANfKP9GsCjZAxRUnsA-1; Wed, 21 Jun 2023 05:57:26 -0400 X-MC-Unique: V7UcANfKP9GsCjZAxRUnsA-1 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 33E3B1C0754C; Wed, 21 Jun 2023 09:57:26 +0000 (UTC) Received: from dmarchan.redhat.com (unknown [10.45.224.210]) by smtp.corp.redhat.com (Postfix) with ESMTP id B1C70492B01; Wed, 21 Jun 2023 09:57:24 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: thomas@monjalon.net, stable@dpdk.org, Shibin Koikkara Reeny , Qi Zhang , Ferruh Yigit , John McNamara Subject: [PATCH] doc: fix link to AF XDP PMD in CNI howto Date: Wed, 21 Jun 2023 11:57:18 +0200 Message-Id: <20230621095718.1625888-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.9 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org 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 --- 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