doc: update doc for idpf and cpfl

Message ID 20230718170212.993131-1-beilei.xing@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Qi Zhang
Headers
Series doc: update doc for idpf and cpfl |

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

Commit Message

Xing, Beilei July 18, 2023, 5:02 p.m. UTC
  From: Beilei Xing <beilei.xing@intel.com>

Add recommended matching list for idpf pmd and cpfl pmd.

Signed-off-by: Beilei Xing <beilei.xing@intel.com>
---
 doc/guides/nics/cpfl.rst | 16 ++++++++++++++++
 doc/guides/nics/idpf.rst | 16 ++++++++++++++++
 2 files changed, 32 insertions(+)
  

Comments

Stephen Hemminger July 19, 2023, 4:15 p.m. UTC | #1
On Tue, 18 Jul 2023 17:02:12 +0000
beilei.xing@intel.com wrote:

> From: Beilei Xing <beilei.xing@intel.com>
> 
> Add recommended matching list for idpf pmd and cpfl pmd.
> 
> Signed-off-by: Beilei Xing <beilei.xing@intel.com>
> ---
>  doc/guides/nics/cpfl.rst | 16 ++++++++++++++++
>  doc/guides/nics/idpf.rst | 16 ++++++++++++++++
>  2 files changed, 32 insertions(+)
> 
> diff --git a/doc/guides/nics/cpfl.rst b/doc/guides/nics/cpfl.rst
> index e88008e16e..258e89ed48 100644
> --- a/doc/guides/nics/cpfl.rst
> +++ b/doc/guides/nics/cpfl.rst
> @@ -21,6 +21,22 @@ To get better performance on Intel platforms,
>  please follow the :doc:`../linux_gsg/nic_perf_intel_platform`.
>  
>  
> +Recommended Matching List
> +-------------------------
> +
> +It is highly recommended to upgrade the MEV-ts release to avoid the compatibility issues
> +with the cpfl PMD.
> +Here is the suggested matching list which has been tested and verified.
> +
> +   +------------+------------------+
> +   |     DPDK   |  MEV-ts release  |
> +   +============+==================+
> +   |    23.03   |      0.6.0       |
> +   +------------+------------------+
> +   |    23.07   |      0.9.1       |
> +   +------------+------------------+
>

Since 23.03 is not an LTS release, it will not be supported when 23.07
is release. Probably best not to clutter up docs with 23.03
  
Xing, Beilei July 25, 2023, 6:57 a.m. UTC | #2
> -----Original Message-----
> From: Stephen Hemminger <stephen@networkplumber.org>
> Sent: Thursday, July 20, 2023 12:15 AM
> To: Xing, Beilei <beilei.xing@intel.com>
> Cc: Wu, Jingjing <jingjing.wu@intel.com>; dev@dpdk.org
> Subject: Re: [PATCH] doc: update doc for idpf and cpfl
> 
> On Tue, 18 Jul 2023 17:02:12 +0000
> beilei.xing@intel.com wrote:
> 
> > From: Beilei Xing <beilei.xing@intel.com>
> >
> > Add recommended matching list for idpf pmd and cpfl pmd.
> >
> > Signed-off-by: Beilei Xing <beilei.xing@intel.com>
> > ---
> >  doc/guides/nics/cpfl.rst | 16 ++++++++++++++++
> > doc/guides/nics/idpf.rst | 16 ++++++++++++++++
> >  2 files changed, 32 insertions(+)
> >
> > diff --git a/doc/guides/nics/cpfl.rst b/doc/guides/nics/cpfl.rst index
> > e88008e16e..258e89ed48 100644
> > --- a/doc/guides/nics/cpfl.rst
> > +++ b/doc/guides/nics/cpfl.rst
> > @@ -21,6 +21,22 @@ To get better performance on Intel platforms,
> > please follow the :doc:`../linux_gsg/nic_perf_intel_platform`.
> >
> >
> > +Recommended Matching List
> > +-------------------------
> > +
> > +It is highly recommended to upgrade the MEV-ts release to avoid the
> > +compatibility issues with the cpfl PMD.
> > +Here is the suggested matching list which has been tested and verified.
> > +
> > +   +------------+------------------+
> > +   |     DPDK   |  MEV-ts release  |
> > +   +============+==================+
> > +   |    23.03   |      0.6.0       |
> > +   +------------+------------------+
> > +   |    23.07   |      0.9.1       |
> > +   +------------+------------------+
> >
> 
> Since 23.03 is not an LTS release, it will not be supported when 23.07 is release.
> Probably best not to clutter up docs with 23.03


Thanks for the comments, will remove 23.03 in next version.
  

Patch

diff --git a/doc/guides/nics/cpfl.rst b/doc/guides/nics/cpfl.rst
index e88008e16e..258e89ed48 100644
--- a/doc/guides/nics/cpfl.rst
+++ b/doc/guides/nics/cpfl.rst
@@ -21,6 +21,22 @@  To get better performance on Intel platforms,
 please follow the :doc:`../linux_gsg/nic_perf_intel_platform`.
 
 
+Recommended Matching List
+-------------------------
+
+It is highly recommended to upgrade the MEV-ts release to avoid the compatibility issues
+with the cpfl PMD.
+Here is the suggested matching list which has been tested and verified.
+
+   +------------+------------------+
+   |     DPDK   |  MEV-ts release  |
+   +============+==================+
+   |    23.03   |      0.6.0       |
+   +------------+------------------+
+   |    23.07   |      0.9.1       |
+   +------------+------------------+
+
+
 Configuration
 -------------
 
diff --git a/doc/guides/nics/idpf.rst b/doc/guides/nics/idpf.rst
index 3693d82255..373ca360e3 100644
--- a/doc/guides/nics/idpf.rst
+++ b/doc/guides/nics/idpf.rst
@@ -19,6 +19,22 @@  To get better performance on Intel platforms,
 please follow the :doc:`../linux_gsg/nic_perf_intel_platform`.
 
 
+Recommended Matching List
+-------------------------
+
+It is highly recommended to upgrade the idpf kernel driver, MEV-ts release to avoid
+the compatibility issues with the idpf PMD.
+Here is the suggested matching list which has been tested and verified.
+
+   +------------+---------------+------------------+
+   |    DPDK    | Kernel Driver |  MEV-ts release  |
+   +============+===============+==================+
+   |    23.03   |    0.0.704    |      0.6.0       |
+   +------------+---------------+------------------+
+   |    23.07   |    0.0.710    |      0.9.1       |
+   +------------+---------------+------------------+
+
+
 Configuration
 -------------