[PATCH v2 0/5] Refactor mlx5 guides

Michael Baum michaelba at nvidia.com
Wed Feb 23 14:48:29 CET 2022


Recently [1] all the drivers running over the mlx5 device started
sharing some objects.
This raised the need to create documentation for the common driver that
would contain information relevant to all drivers and in particular:

 - Tutorial for configuration of the device.
 - Instruction for using Mellanox ofed.
 - devargs of the common driver.

This series adds such documentation and reference to it as parts of the
documentation of the other drivers.

[1]
https://patchwork.dpdk.org/project/dpdk/cover/20211019205602.3188203-1-michaelba@nvidia.com/

v2: Rebase


Michael Baum (5):
  doc: remove obsolete explanations from mlx5 guide
  doc: replace broken links in mlx5 guide
  doc: correct name of BlueField-2 in mlx5 guide
  doc: add shared guide for mlx5 PMDs
  doc: update doorbell mapping parameter name in mlx5 guide

 doc/guides/compressdevs/mlx5.rst           |  40 +-
 doc/guides/cryptodevs/mlx5.rst             |  38 +-
 doc/guides/nics/mlx4.rst                   |   4 +-
 doc/guides/nics/mlx5.rst                   | 567 +-----------------
 doc/guides/platform/index.rst              |   1 +
 doc/guides/platform/mlx5.rst               | 641 +++++++++++++++++++++
 doc/guides/regexdevs/mlx5.rst              |  44 +-
 doc/guides/vdpadevs/mlx5.rst               |  87 +--
 drivers/common/mlx5/linux/mlx5_common_os.c |   2 +-
 drivers/common/mlx5/mlx5_common.c          |  31 +-
 drivers/common/mlx5/mlx5_common_defs.h     |   8 +-
 drivers/net/mlx5/linux/mlx5_verbs.c        |   2 +-
 drivers/net/mlx5/mlx5_devx.c               |   2 +-
 13 files changed, 747 insertions(+), 720 deletions(-)
 create mode 100644 doc/guides/platform/mlx5.rst

-- 
2.25.1



More information about the dev mailing list