[dpdk-dev] [PATCH 5/8] doc: fix driver names in NIC devices guide

Xu, Rosen rosen.xu at intel.com
Tue Nov 3 03:31:49 CET 2020



> Subject: [PATCH 5/8] doc: fix driver names in NIC devices guide
> 
> Since the built driver filenames have changed in DPDK 20.11, we need to
> update the driver doc to match.
> 
> Most drivers start their section with the driver filename highlighted in bold,
> while a number were missing the highlight. When updating the names, add
> the markers for bold text to any missing it, so as to have things more
> consistent.
> 
> Fixes: a20b2c01a7a1 ("build: standardize component names and defines")
> 
> Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
> ---
> 
> NOTE: the mlx4 and mlx5 chapters include a lot of output text which includes
> the driver name. I have updated this in the patch to use the new name, but
> at least for mlx4 I can't see some of the quoted printouts in the code any
> more, and for both drivers I think the output needs to be double-checked for
> correctness by maintainers.
> 
> ---
>  doc/guides/nics/ark.rst         |  2 +-
>  doc/guides/nics/axgbe.rst       |  2 +-
>  doc/guides/nics/bnx2x.rst       |  2 +-
>  doc/guides/nics/bnxt.rst        |  2 +-
>  doc/guides/nics/cxgbe.rst       |  8 ++--
>  doc/guides/nics/dpaa.rst        |  2 +-
>  doc/guides/nics/dpaa2.rst       |  2 +-
>  doc/guides/nics/ena.rst         |  2 +-
>  doc/guides/nics/enetc.rst       |  2 +-
>  doc/guides/nics/fail_safe.rst   |  2 +-
>  doc/guides/nics/hinic.rst       |  2 +-
>  doc/guides/nics/hns3.rst        |  2 +-
>  doc/guides/nics/i40e.rst        |  2 +-
>  doc/guides/nics/ice.rst         |  2 +-
>  doc/guides/nics/igb.rst         |  2 +-
>  doc/guides/nics/igc.rst         |  2 +-
>  doc/guides/nics/ipn3ke.rst      |  2 +-
>  doc/guides/nics/liquidio.rst    |  2 +-
>  doc/guides/nics/mlx4.rst        | 52 +++++++++++++-------------
>  doc/guides/nics/mlx5.rst        | 66 ++++++++++++++++-----------------
>  doc/guides/nics/mvneta.rst      |  2 +-
>  doc/guides/nics/mvpp2.rst       |  2 +-
>  doc/guides/nics/octeontx.rst    |  2 +-
>  doc/guides/nics/octeontx2.rst   |  2 +-
>  doc/guides/nics/pcap_ring.rst   |  4 +-
>  doc/guides/nics/pfe.rst         |  2 +-
>  doc/guides/nics/qede.rst        |  4 +-
>  doc/guides/nics/sfc_efx.rst     |  2 +-
>  doc/guides/nics/thunderx.rst    |  4 +-
>  doc/guides/nics/vdev_netvsc.rst |  2 +-
>  30 files changed, 93 insertions(+), 93 deletions(-)
> 
>  - For information about I225, please refer to:
> diff --git a/doc/guides/nics/ipn3ke.rst b/doc/guides/nics/ipn3ke.rst index
> 5d4534e4da..a89e3719f2 100644
> --- a/doc/guides/nics/ipn3ke.rst
> +++ b/doc/guides/nics/ipn3ke.rst
> @@ -4,7 +4,7 @@
>  IPN3KE Poll Mode Driver
>  =======================
> 
> -The ipn3ke PMD (librte_pmd_ipn3ke) provides poll mode driver support
> +The ipn3ke PMD (**librte_net_ipn3ke**) provides poll mode driver
> +support
>  for Intel® FPGA PAC(Programmable Acceleration Card) N3000 based on  the
> Intel Ethernet Controller X710/XXV710 and Intel Arria 10 FPGA.

Reviewed-by: Rosen Xu <rosen.xu at intel.com>



More information about the dev mailing list