[PATCH 00/33] Update net driver documentation

[Zhang, Qi Z]

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit at amd.com>
> Sent: Wednesday, March 22, 2023 7:59 AM
> To: Mcnamara, John <john.mcnamara at intel.com>
> Cc: Thomas Monjalon <thomas at monjalon.net>; Andrew Rybchenko
> <andrew.rybchenko at oktetlabs.ru>; dev at dpdk.org
> Subject: [PATCH 00/33] Update net driver documentation
> 
> Some PMDs has "Pre-Installation Configuration" section in their
> documentation, although section is not clear I assume that is historical from
> times compile time parameters and 'make' build system used, where
> common make target was 'install', so section refers to compile time
> configuration.
> 
> Right now device arguments ("Runtime configuration") is documented under
> this section which is confusing, so updating section name from "Pre-
> Installation Configuration" to "Configuration".
> 
> While touching documents trying to keep following template in the
> documents, with section names and order, to have consistent documents
> without being too strict on applying the template:
> 
> 	[Overview]
> 	Supported Devices
> 	Supported Features
> 	Prerequisites
> 	Configuration
> 		Compilation Options
> 		Environment variables
> 		Runtime Configuration
> 	Debugging
> 	Limitations or Known issues
> 	Testpmd driver specific commands
> 
> Note: Patch sent as each driver separately to help review, it can be squashed
> while merging.
> 
> Other further improvements not covered here can be visiting  "Building
> DPDK" sections which has redundant and less useful information,  and
> "Usage example" section which has testpmd log, most of the part is same for
> all drivers.
> 
> .
> 
> Ferruh Yigit (33):
>   doc: update atlantic guide
>   doc: update cpfl guide
>   doc: update cxgbe guide
>   doc: update dpaa guide
>   doc: update ena guide
>   doc: update enetc guide
>   doc: update enetfec guide
>   doc: update enic guide
>   doc: update hns3 guide
>   doc: update i40e guide
>   doc: update ice guide
>   doc: update idpf guide
>   doc: update igb guide
>   doc: update igc guide
>   doc: update ipn3ke guide
>   doc: update ixgbe guide
>   doc: update kni guide
>   doc: update mana guide
>   doc: update mlx5 guide
>   doc: update mvneta guide
>   doc: update netvsc guide
>   doc: update ngbe guide
>   doc: update net null guide
>   doc: update octeontx guide
>   doc: update pfe guide
>   doc: update qede guide
>   doc: update sfc guide
>   doc: update softnic guide
>   doc: update thunderx guide
>   doc: update txgbe guide
>   doc: update vdev netvsc guide
>   doc: update vhost guide
>   doc: update virtio guide
> 
>  doc/guides/nics/atlantic.rst    |  27 +++-----
>  doc/guides/nics/cpfl.rst        |  51 +++++++-------
>  doc/guides/nics/cxgbe.rst       |  61 ++++++++---------
>  doc/guides/nics/dpaa.rst        |   5 +-
>  doc/guides/nics/ena.rst         |  60 +++++++++--------
>  doc/guides/nics/enetc.rst       |  25 +++----
>  doc/guides/nics/enetfec.rst     |  12 ++--
>  doc/guides/nics/enic.rst        |  79 ++++++++++------------
>  doc/guides/nics/hns3.rst        |  30 ++++-----
>  doc/guides/nics/i40e.rst        |  10 +--
>  doc/guides/nics/ice.rst         |   8 +--
>  doc/guides/nics/idpf.rst        |   8 +--
>  doc/guides/nics/igb.rst         |  23 +++----
>  doc/guides/nics/igc.rst         |  16 ++---
>  doc/guides/nics/ipn3ke.rst      |   9 ++-
>  doc/guides/nics/ixgbe.rst       |  62 ++++++++---------
>  doc/guides/nics/kni.rst         |   4 +-
>  doc/guides/nics/mana.rst        |   4 +-
>  doc/guides/nics/mlx5.rst        | 116 ++++++++++++++++----------------
>  doc/guides/nics/mvneta.rst      |   4 +-
>  doc/guides/nics/netvsc.rst      |   4 +-
>  doc/guides/nics/ngbe.rst        |   4 +-
>  doc/guides/nics/null.rst        |   4 +-
>  doc/guides/nics/octeontx.rst    |  15 ++---
>  doc/guides/nics/pfe.rst         |  25 +++----
>  doc/guides/nics/qede.rst        |  14 ++--
>  doc/guides/nics/sfc_efx.rst     |  94 +++++++++++++-------------
>  doc/guides/nics/softnic.rst     |   4 +-
>  doc/guides/nics/thunderx.rst    |  16 ++---
>  doc/guides/nics/txgbe.rst       |  12 ++--
>  doc/guides/nics/vdev_netvsc.rst |   4 +-
>  doc/guides/nics/vhost.rst       |   4 +-
>  doc/guides/nics/virtio.rst      |   4 +-
>  33 files changed, 395 insertions(+), 423 deletions(-)
> 
> --
> 2.34.1

For Intel nic i40e/ice/ixgbe/idpf/cpfl/igb/igc/ipn3ke

Acked-by: Qi Zhang <qi.z.zhang at intel.com>

Thanks!