[v1,1/1] docs: af_xdp device plugin repo update

Message ID 20240425150902.1364384-1-mtahhan@redhat.com (mailing list archive)
State Changes Requested
Delegated to: Ferruh Yigit
Headers
Series [v1,1/1] docs: af_xdp device plugin repo update |

Checks

Context Check Description
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-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS

Commit Message

Maryam Tahhan April 25, 2024, 3:08 p.m. UTC
  Fixup the references to the AF_XDP Device Plugin repo.

Fixes: 66a2aca4f512 ("docs: fix AF_XDP device plugin howto")
Cc: stable@dpdk.org

Signed-off-by: Maryam Tahhan <mtahhan@redhat.com>
---
 doc/guides/howto/af_xdp_cni.rst | 12 ++++++------
 doc/guides/nics/af_xdp.rst      |  2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)
  

Comments

Loftus, Ciara April 26, 2024, 9:16 a.m. UTC | #1
> Subject: [v1 1/1] docs: af_xdp device plugin repo update
> 
> Fixup the references to the AF_XDP Device Plugin repo.
> 
> Fixes: 66a2aca4f512 ("docs: fix AF_XDP device plugin howto")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Maryam Tahhan <mtahhan@redhat.com>

Acked-by: Ciara Loftus <ciara.loftus@intel.com>

> ---
>  doc/guides/howto/af_xdp_cni.rst | 12 ++++++------
>  doc/guides/nics/af_xdp.rst      |  2 +-
>  2 files changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/doc/guides/howto/af_xdp_cni.rst
> b/doc/guides/howto/af_xdp_cni.rst
> index a1a6d5b99c..63345ec79c 100644
> --- a/doc/guides/howto/af_xdp_cni.rst
> +++ b/doc/guides/howto/af_xdp_cni.rst
> @@ -16,7 +16,7 @@ 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 :doc:`../nics/af_xdp` to connect and use these
> technologies.
> 
> -.. _AF_XDP Plugin for Kubernetes: https://github.com/intel/afxdp-plugins-
> for-kubernetes
> +.. _AF_XDP Plugin for Kubernetes: https://github.com/redhat-et/afxdp-
> plugins-for-kubernetes
> 
> 
>  Background
> @@ -91,7 +91,7 @@ Howto run dpdk-testpmd with CNI plugin:
> 
>    .. code-block:: console
> 
> -     # git clone https://github.com/intel/afxdp-plugins-for-kubernetes.git
> +     # git clone https://github.com/redhat-et/afxdp-plugins-for-kubernetes.git
> 
>  * Build the CNI plugin
> 
> @@ -128,7 +128,7 @@ Howto run dpdk-testpmd with CNI plugin:
> 
>    For further reference please use the `config.json`_
> 
> -  .. _config.json: https://github.com/intel/afxdp-plugins-for-
> kubernetes/blob/v0.0.2/test/e2e/config.json
> +  .. _config.json: https://github.com/redhat-et/afxdp-plugins-for-
> kubernetes/blob/v0.0.2/test/e2e/config.json
> 
>  * Create the Network Attachment definition
> 
> @@ -167,7 +167,7 @@ Howto run dpdk-testpmd with CNI plugin:
> 
>    For further reference please use the `nad.yaml`_
> 
> -  .. _nad.yaml: https://github.com/intel/afxdp-plugins-for-
> kubernetes/blob/v0.0.2/test/e2e/nad.yaml
> +  .. _nad.yaml: https://github.com/redhat-et/afxdp-plugins-for-
> kubernetes/blob/v0.0.2/test/e2e/nad.yaml
> 
>  * Build the Docker image
> 
> @@ -237,7 +237,7 @@ Howto run dpdk-testpmd with CNI plugin:
> 
>    For further reference please use the `pod.yaml`_
> 
> -  .. _pod.yaml: https://github.com/intel/afxdp-plugins-for-
> kubernetes/blob/v0.0.2/test/e2e/pod-1c1d.yaml
> +  .. _pod.yaml: https://github.com/redhat-et/afxdp-plugins-for-
> kubernetes/blob/v0.0.2/test/e2e/pod-1c1d.yaml
> 
>  * Run DPDK with a command like the following:
> 
> @@ -250,4 +250,4 @@ Howto run dpdk-testpmd with CNI plugin:
> 
>  For further reference please use the `e2e`_ test case in `AF_XDP Plugin for
> Kubernetes`_
> 
> -  .. _e2e: https://github.com/intel/afxdp-plugins-for-
> kubernetes/tree/v0.0.2/test/e2e
> +  .. _e2e: https://github.com/redhat-et/afxdp-plugins-for-
> kubernetes/tree/v0.0.2/test/e2e
> diff --git a/doc/guides/nics/af_xdp.rst b/doc/guides/nics/af_xdp.rst
> index 1932525d4d..4612168122 100644
> --- a/doc/guides/nics/af_xdp.rst
> +++ b/doc/guides/nics/af_xdp.rst
> @@ -157,7 +157,7 @@ use_cni
>  The EAL vdev argument ``use_cni`` is used to indicate that the user wishes to
>  enable the `AF_XDP Plugin for Kubernetes`_ within a DPDK application.
> 
> -.. _AF_XDP Plugin for Kubernetes: https://github.com/intel/afxdp-plugins-
> for-kubernetes
> +.. _AF_XDP Plugin for Kubernetes: https://github.com/redhat-et/afxdp-
> plugins-for-kubernetes
> 
>  .. code-block:: console
> 
> --
> 2.41.0
  
Ferruh Yigit April 26, 2024, 2:54 p.m. UTC | #2
On 4/25/2024 4:08 PM, Maryam Tahhan wrote:
> Fixup the references to the AF_XDP Device Plugin repo.
> 
> Fixes: 66a2aca4f512 ("docs: fix AF_XDP device plugin howto")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Maryam Tahhan <mtahhan@redhat.com>
> ---
>  doc/guides/howto/af_xdp_cni.rst | 12 ++++++------
>  doc/guides/nics/af_xdp.rst      |  2 +-
>  2 files changed, 7 insertions(+), 7 deletions(-)
>

Hi Maryam,

'af_xdp_cni.rst' is renamed to 'af_xdp_dp.rst' by one of your previous
patch.

I assume you did this patch on top of latest 'main' repo, but as af_xdp
patches merged on next-net [1] repo, can you please make your patch on
top of it?


[1]
https://git.dpdk.org/next/dpdk-next-net/
  
Patrick Robb April 26, 2024, 9:32 p.m. UTC | #3
Recheck-request: iol-compile-amd64-testing

The DPDK Community Lab updated to the latest Alpine image yesterday, which
resulted in all Alpine builds failing. The failure is unrelated to your
patch, and this recheck should remove the fail on Patchwork, as we have
disabled Alpine testing for now.
  
Maryam Tahhan April 29, 2024, 12:52 p.m. UTC | #4
On 26/04/2024 15:54, Ferruh Yigit wrote:
> On 4/25/2024 4:08 PM, Maryam Tahhan wrote:
>> Fixup the references to the AF_XDP Device Plugin repo.
>>
>> Fixes: 66a2aca4f512 ("docs: fix AF_XDP device plugin howto")
>> Cc:stable@dpdk.org
>>
>> Signed-off-by: Maryam Tahhan<mtahhan@redhat.com>
>> ---
>>   doc/guides/howto/af_xdp_cni.rst | 12 ++++++------
>>   doc/guides/nics/af_xdp.rst      |  2 +-
>>   2 files changed, 7 insertions(+), 7 deletions(-)
>>
> Hi Maryam,
>
> 'af_xdp_cni.rst' is renamed to 'af_xdp_dp.rst' by one of your previous
> patch.
>
> I assume you did this patch on top of latest 'main' repo, but as af_xdp
> patches merged on next-net [1] repo, can you please make your patch on
> top of it?

Sorry I did make the change on top of main - I will rebase it 
ondpdk-next-net/ and resubmit

>
>
> [1]
> https://git.dpdk.org/next/dpdk-next-net/
>
  

Patch

diff --git a/doc/guides/howto/af_xdp_cni.rst b/doc/guides/howto/af_xdp_cni.rst
index a1a6d5b99c..63345ec79c 100644
--- a/doc/guides/howto/af_xdp_cni.rst
+++ b/doc/guides/howto/af_xdp_cni.rst
@@ -16,7 +16,7 @@  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 :doc:`../nics/af_xdp` to connect and use these technologies.
 
-.. _AF_XDP Plugin for Kubernetes: https://github.com/intel/afxdp-plugins-for-kubernetes
+.. _AF_XDP Plugin for Kubernetes: https://github.com/redhat-et/afxdp-plugins-for-kubernetes
 
 
 Background
@@ -91,7 +91,7 @@  Howto run dpdk-testpmd with CNI plugin:
 
   .. code-block:: console
 
-     # git clone https://github.com/intel/afxdp-plugins-for-kubernetes.git
+     # git clone https://github.com/redhat-et/afxdp-plugins-for-kubernetes.git
 
 * Build the CNI plugin
 
@@ -128,7 +128,7 @@  Howto run dpdk-testpmd with CNI plugin:
 
   For further reference please use the `config.json`_
 
-  .. _config.json: https://github.com/intel/afxdp-plugins-for-kubernetes/blob/v0.0.2/test/e2e/config.json
+  .. _config.json: https://github.com/redhat-et/afxdp-plugins-for-kubernetes/blob/v0.0.2/test/e2e/config.json
 
 * Create the Network Attachment definition
 
@@ -167,7 +167,7 @@  Howto run dpdk-testpmd with CNI plugin:
 
   For further reference please use the `nad.yaml`_
 
-  .. _nad.yaml: https://github.com/intel/afxdp-plugins-for-kubernetes/blob/v0.0.2/test/e2e/nad.yaml
+  .. _nad.yaml: https://github.com/redhat-et/afxdp-plugins-for-kubernetes/blob/v0.0.2/test/e2e/nad.yaml
 
 * Build the Docker image
 
@@ -237,7 +237,7 @@  Howto run dpdk-testpmd with CNI plugin:
 
   For further reference please use the `pod.yaml`_
 
-  .. _pod.yaml: https://github.com/intel/afxdp-plugins-for-kubernetes/blob/v0.0.2/test/e2e/pod-1c1d.yaml
+  .. _pod.yaml: https://github.com/redhat-et/afxdp-plugins-for-kubernetes/blob/v0.0.2/test/e2e/pod-1c1d.yaml
 
 * Run DPDK with a command like the following:
 
@@ -250,4 +250,4 @@  Howto run dpdk-testpmd with CNI plugin:
 
 For further reference please use the `e2e`_ test case in `AF_XDP Plugin for Kubernetes`_
 
-  .. _e2e: https://github.com/intel/afxdp-plugins-for-kubernetes/tree/v0.0.2/test/e2e
+  .. _e2e: https://github.com/redhat-et/afxdp-plugins-for-kubernetes/tree/v0.0.2/test/e2e
diff --git a/doc/guides/nics/af_xdp.rst b/doc/guides/nics/af_xdp.rst
index 1932525d4d..4612168122 100644
--- a/doc/guides/nics/af_xdp.rst
+++ b/doc/guides/nics/af_xdp.rst
@@ -157,7 +157,7 @@  use_cni
 The EAL vdev argument ``use_cni`` is used to indicate that the user wishes to
 enable the `AF_XDP Plugin for Kubernetes`_ within a DPDK application.
 
-.. _AF_XDP Plugin for Kubernetes: https://github.com/intel/afxdp-plugins-for-kubernetes
+.. _AF_XDP Plugin for Kubernetes: https://github.com/redhat-et/afxdp-plugins-for-kubernetes
 
 .. code-block:: console