[02/33] doc: update cpfl guide

Message ID 20230321235941.2169068-3-ferruh.yigit@amd.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series Update net driver documentation |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Ferruh Yigit March 21, 2023, 11:59 p.m. UTC
  - Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Runtime Config Options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/cpfl.rst | 51 ++++++++++++++++++++--------------------
 1 file changed, 25 insertions(+), 26 deletions(-)
  

Patch

diff --git a/doc/guides/nics/cpfl.rst b/doc/guides/nics/cpfl.rst
index e2d71f8a4c20..91dbec306dbb 100644
--- a/doc/guides/nics/cpfl.rst
+++ b/doc/guides/nics/cpfl.rst
@@ -20,12 +20,33 @@  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
+--------
 
-Pre-Installation Configuration
-------------------------------
+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
+-------------
 
-Runtime Config Options
-~~~~~~~~~~~~~~~~~~~~~~
+Runtime Configuration
+~~~~~~~~~~~~~~~~~~~~~
 
 - ``vport`` (default ``0``)
 
@@ -83,25 +104,3 @@  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.