diff mbox series

[27/33] doc: update sfc guide

Message ID 20230321235941.2169068-28-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 
  - Move "Supported NICs" section to top
- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Build Options" section to "Compilation Options"
- Rename "Per-Device Parameters" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/sfc_efx.rst | 94 ++++++++++++++++++-------------------
 1 file changed, 47 insertions(+), 47 deletions(-)
diff mbox series

Patch

diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst
index fcad671da20c..de0656876b96 100644
--- a/doc/guides/nics/sfc_efx.rst
+++ b/doc/guides/nics/sfc_efx.rst
@@ -18,6 +18,48 @@  More information can be found at `Solarflare Communications website
 <http://solarflare.com>`_.
 
 
+Supported NICs
+--------------
+
+- Xilinx Adapters:
+
+   - Alveo SN1022 SmartNIC
+
+- Solarflare XtremeScale Adapters:
+
+   - Solarflare X2522 Dual Port SFP28 10/25GbE Adapter
+
+   - Solarflare X2541 Single Port QSFP28 10/25G/100G Adapter
+
+   - Solarflare X2542 Dual Port QSFP28 10/25G/100G Adapter
+
+- Solarflare Flareon [Ultra] Server Adapters:
+
+   - Solarflare SFN8522 Dual Port SFP+ Server Adapter
+
+   - Solarflare SFN8522M Dual Port SFP+ Server Adapter
+
+   - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
+
+   - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
+
+   - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
+
+   - Solarflare SFN7002F Dual Port SFP+ Server Adapter
+
+   - Solarflare SFN7004F Quad Port SFP+ Server Adapter
+
+   - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
+
+   - Solarflare SFN7122F Dual Port SFP+ Server Adapter
+
+   - Solarflare SFN7124F Quad Port SFP+ Server Adapter
+
+   - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
+
+   - Solarflare SFN7322F Precision Time Synchronization Server Adapter
+
+
 Features
 --------
 
@@ -290,48 +332,6 @@  conditions is met:
 - The last item is TCP or UDP, and it's empty.
 
 
-Supported NICs
---------------
-
-- Xilinx Adapters:
-
-   - Alveo SN1022 SmartNIC
-
-- Solarflare XtremeScale Adapters:
-
-   - Solarflare X2522 Dual Port SFP28 10/25GbE Adapter
-
-   - Solarflare X2541 Single Port QSFP28 10/25G/100G Adapter
-
-   - Solarflare X2542 Dual Port QSFP28 10/25G/100G Adapter
-
-- Solarflare Flareon [Ultra] Server Adapters:
-
-   - Solarflare SFN8522 Dual Port SFP+ Server Adapter
-
-   - Solarflare SFN8522M Dual Port SFP+ Server Adapter
-
-   - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
-
-   - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
-
-   - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
-
-   - Solarflare SFN7002F Dual Port SFP+ Server Adapter
-
-   - Solarflare SFN7004F Quad Port SFP+ Server Adapter
-
-   - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
-
-   - Solarflare SFN7122F Dual Port SFP+ Server Adapter
-
-   - Solarflare SFN7124F Quad Port SFP+ Server Adapter
-
-   - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
-
-   - Solarflare SFN7322F Precision Time Synchronization Server Adapter
-
-
 Prerequisites
 -------------
 
@@ -347,12 +347,12 @@  Follow instructions from Solarflare Server Adapter User's Guide to
 update firmware and configure the adapter.
 
 
-Pre-Installation Configuration
-------------------------------
+Configuration
+-------------
 
 
-Build Options
-~~~~~~~~~~~~~
+Compilation Options
+~~~~~~~~~~~~~~~~~~~
 
 The following build-time options may be enabled on build time using
 ``-Dc_args=`` meson argument (e.g.  ``-Dc_args=-DRTE_LIBRTE_SFC_EFX_DEBUG``).
@@ -364,7 +364,7 @@  Please note that enabling debugging options may affect system performance.
   Enable compilation of the extra run-time consistency checks.
 
 
-Per-Device Parameters
+Runtime Configuration
 ~~~~~~~~~~~~~~~~~~~~~
 
 The following per-device parameters can be passed via EAL PCI device