From: Ferruh Yigit <ferruh.yigit@amd.com>
To: John McNamara <john.mcnamara@intel.com>
Cc: Thomas Monjalon <thomas@monjalon.net>,
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>, <dev@dpdk.org>
Subject: [PATCH 00/33] Update net driver documentation
Date: Tue, 21 Mar 2023 23:59:08 +0000 [thread overview]
Message-ID: <20230321235941.2169068-1-ferruh.yigit@amd.com> (raw)
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
next reply other threads:[~2023-03-22 0:00 UTC|newest]
Thread overview: 54+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-21 23:59 Ferruh Yigit [this message]
2023-03-21 23:59 ` [PATCH 01/33] doc: update atlantic guide Ferruh Yigit
2023-03-22 10:21 ` [EXT] " Igor Russkikh
2023-03-21 23:59 ` [PATCH 02/33] doc: update cpfl guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 03/33] doc: update cxgbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 04/33] doc: update dpaa guide Ferruh Yigit
2023-03-22 9:01 ` Sachin Saxena (OSS)
2023-03-21 23:59 ` [PATCH 05/33] doc: update ena guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 06/33] doc: update enetc guide Ferruh Yigit
2023-03-22 9:07 ` Sachin Saxena (OSS)
2023-03-21 23:59 ` [PATCH 07/33] doc: update enetfec guide Ferruh Yigit
2023-03-22 9:08 ` Sachin Saxena (OSS)
2023-03-21 23:59 ` [PATCH 08/33] doc: update enic guide Ferruh Yigit
2023-03-22 2:32 ` Hyong Youb Kim (hyonkim)
2023-03-21 23:59 ` [PATCH 09/33] doc: update hns3 guide Ferruh Yigit
2023-03-22 0:33 ` fengchengwen
2023-03-22 7:54 ` Dongdong Liu
2023-03-21 23:59 ` [PATCH 10/33] doc: update i40e guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 11/33] doc: update ice guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 12/33] doc: update idpf guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 13/33] doc: update igb guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 14/33] doc: update igc guide Ferruh Yigit
2023-03-22 2:31 ` Su, Simei
2023-03-21 23:59 ` [PATCH 15/33] doc: update ipn3ke guide Ferruh Yigit
2023-03-22 1:41 ` Xu, Rosen
2023-03-21 23:59 ` [PATCH 16/33] doc: update ixgbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 17/33] doc: update kni guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 18/33] doc: update mana guide Ferruh Yigit
2023-03-22 0:09 ` Long Li
2023-03-21 23:59 ` [PATCH 19/33] doc: update mlx5 guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 20/33] doc: update mvneta guide Ferruh Yigit
2023-03-22 11:45 ` [EXT] " Liron Himi
2023-03-21 23:59 ` [PATCH 21/33] doc: update netvsc guide Ferruh Yigit
2023-03-22 0:09 ` Long Li
2023-03-21 23:59 ` [PATCH 22/33] doc: update ngbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 23/33] doc: update net null guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 24/33] doc: update octeontx guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 25/33] doc: update pfe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 26/33] doc: update qede guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 27/33] doc: update sfc guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 28/33] doc: update softnic guide Ferruh Yigit
2023-03-22 12:43 ` Dumitrescu, Cristian
2023-03-21 23:59 ` [PATCH 29/33] doc: update thunderx guide Ferruh Yigit
2023-03-22 13:18 ` Jerin Jacob
2023-03-21 23:59 ` [PATCH 30/33] doc: update txgbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 31/33] doc: update vdev netvsc guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 32/33] doc: update vhost guide Ferruh Yigit
2023-03-22 2:17 ` Xia, Chenbo
2023-03-21 23:59 ` [PATCH 33/33] doc: update virtio guide Ferruh Yigit
2023-03-22 2:17 ` Xia, Chenbo
2023-03-22 0:48 ` [PATCH 00/33] Update net driver documentation fengchengwen
2023-03-22 8:43 ` Ferruh Yigit
2023-03-22 2:53 ` Zhang, Qi Z
2023-03-28 16:59 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230321235941.2169068-1-ferruh.yigit@amd.com \
--to=ferruh.yigit@amd.com \
--cc=andrew.rybchenko@oktetlabs.ru \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).