[PATCH] net/cpfl: update the doc of CPFL PMD

[PATCH] net/cpfl: update the doc of CPFL PMD

[Mingxia Liu]

This patch updates cpfl.rst doc, adjusting the order of chapters
referring to IDPF PMD doc.

Signed-off-by: Mingxia Liu <mingxia.liu@intel.com>
---
 doc/guides/nics/cpfl.rst | 44 +++++++++++++++++++++-------------------
 1 file changed, 23 insertions(+), 21 deletions(-)

diff --git a/doc/guides/nics/cpfl.rst b/doc/guides/nics/cpfl.rst
index 91dbec306d..d25db088eb 100644
--- a/doc/guides/nics/cpfl.rst
+++ b/doc/guides/nics/cpfl.rst
@@ -20,27 +20,6 @@ Follow the DPDK :doc:`../linux_gsg/index` to setup the basic DPDK environment.
 To get better performance on Intel platforms,
 please follow the :doc:`../linux_gsg/nic_perf_intel_platform`.
 
-Features
---------
-
-Vector PMD
-~~~~~~~~~~
-
-Vector path for Rx and Tx path are selected automatically.
-The paths are chosen based on 2 conditions:
-
-- ``CPU``
-
-  On the x86 platform, the driver checks if the CPU supports AVX512.
-  If the CPU supports AVX512 and EAL argument ``--force-max-simd-bitwidth``
-  is set to 512, AVX512 paths will be chosen.
-
-- ``Offload features``
-
-  The supported HW offload features are described in the document cpfl.ini,
-  A value "P" means the offload feature is not supported by vector path.
-  If any not supported features are used, cpfl vector PMD is disabled
-  and the scalar paths are chosen.
 
 Configuration
 -------------
@@ -104,3 +83,26 @@ Driver compilation and testing
 ------------------------------
 
 Refer to the document :doc:`build_and_test` for details.
+
+
+Features
+--------
+
+Vector PMD
+~~~~~~~~~~
+
+Vector path for Rx and Tx path are selected automatically.
+The paths are chosen based on 2 conditions:
+
+- ``CPU``
+
+  On the x86 platform, the driver checks if the CPU supports AVX512.
+  If the CPU supports AVX512 and EAL argument ``--force-max-simd-bitwidth``
+  is set to 512, AVX512 paths will be chosen.
+
+- ``Offload features``
+
+  The supported HW offload features are described in the document cpfl.ini,
+  A value "P" means the offload feature is not supported by vector path.
+  If any not supported features are used, cpfl vector PMD is disabled
+  and the scalar paths are chosen.
-- 
2.34.1

RE: [PATCH] net/cpfl: update the doc of CPFL PMD

[Xing, Beilei]

> -----Original Message-----
> From: Liu, Mingxia <mingxia.liu@intel.com>
> Sent: Friday, April 21, 2023 10:59 PM
> To: dev@dpdk.org; Xing, Beilei <beilei.xing@intel.com>; Zhang, Yuying
> <yuying.zhang@intel.com>
> Cc: Liu, Mingxia <mingxia.liu@intel.com>
> Subject: [PATCH] net/cpfl: update the doc of CPFL PMD
> 
> This patch updates cpfl.rst doc, adjusting the order of chapters referring to
> IDPF PMD doc.
> 
> Signed-off-by: Mingxia Liu <mingxia.liu@intel.com>

Acked-by: Beilei Xing <beilei.xing@intel.com>

RE: [PATCH] net/cpfl: update the doc of CPFL PMD

[Zhang, Qi Z]

> -----Original Message-----
> From: Xing, Beilei <beilei.xing@intel.com>
> Sent: Monday, May 15, 2023 1:06 PM
> To: Liu, Mingxia <mingxia.liu@intel.com>; dev@dpdk.org; Zhang, Yuying
> <yuying.zhang@intel.com>
> Subject: RE: [PATCH] net/cpfl: update the doc of CPFL PMD
> 
> 
> 
> > -----Original Message-----
> > From: Liu, Mingxia <mingxia.liu@intel.com>
> > Sent: Friday, April 21, 2023 10:59 PM
> > To: dev@dpdk.org; Xing, Beilei <beilei.xing@intel.com>; Zhang, Yuying
> > <yuying.zhang@intel.com>
> > Cc: Liu, Mingxia <mingxia.liu@intel.com>
> > Subject: [PATCH] net/cpfl: update the doc of CPFL PMD
> >
> > This patch updates cpfl.rst doc, adjusting the order of chapters
> > referring to IDPF PMD doc.
> >
> > Signed-off-by: Mingxia Liu <mingxia.liu@intel.com>
> 
> Acked-by: Beilei Xing <beilei.xing@intel.com>

Applied to dpdk-next-net-intel.

Thanks
Qi