[01/33] doc: update atlantic guide

Message ID 20230321235941.2169068-2-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 Chipsets and NICs" section to top
- Fix section indentation
- Remove empty sections

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/atlantic.rst | 27 ++++++++++-----------------
 1 file changed, 10 insertions(+), 17 deletions(-)
  

Comments

Igor Russkikh March 22, 2023, 10:21 a.m. UTC | #1
> - Move "Supported Chipsets and NICs" section to top
> - Fix section indentation
> - Remove empty sections
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>


Thanks for taking care, Ferruh!

Reviewed-by: Igor Russkikh <irusskikh@marvell.com>
  

Patch

diff --git a/doc/guides/nics/atlantic.rst b/doc/guides/nics/atlantic.rst
index 605f6dc3ab10..104e642c3c5a 100644
--- a/doc/guides/nics/atlantic.rst
+++ b/doc/guides/nics/atlantic.rst
@@ -9,8 +9,15 @@  Atlantic DPDK driver provides DPDK support for Aquantia's AQtion family of chips
 More information can be found at `Aquantia Official Website
 <https://www.aquantia.com/products/client-connectivity/>`_.
 
+Supported Chipsets and NICs
+---------------------------
+
+- Aquantia AQtion AQC107 10 Gigabit Ethernet Controller
+- Aquantia AQtion AQC108 5 Gigabit Ethernet Controller
+- Aquantia AQtion AQC109 2.5 Gigabit Ethernet Controller
+
 Supported features
-^^^^^^^^^^^^^^^^^^
+------------------
 
 - Base L2 features
 - Promiscuous mode
@@ -22,28 +29,14 @@  Supported features
 - MACSEC offload
 
 Experimental API features
-^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------
 
 - MACSEC PMD API is considered as experimental and is subject to change/removal in next DPDK releases.
 
-
-Application Programming Interface
----------------------------------
-
 Limitations or Known issues
 ---------------------------
 
-Statistics
-~~~~~~~~~~
-
 MTU setting
-~~~~~~~~~~~
+^^^^^^^^^^^
 
 Atlantic NIC supports up to 16K jumbo frame size
-
-Supported Chipsets and NICs
----------------------------
-
-- Aquantia AQtion AQC107 10 Gigabit Ethernet Controller
-- Aquantia AQtion AQC108 5 Gigabit Ethernet Controller
-- Aquantia AQtion AQC109 2.5 Gigabit Ethernet Controller