Skip to content

Refactor mlx5 guides

Michael Baum dpdk-dev 2 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest5 patches 4 repliesIn review
  2. v15 patches 1 replySuperseded

Patches in v2 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5doc: remove obsolete explanations from mlx5 guidedoc/guides/nics/mlx5.rst+0 -90 replies
2/5doc: replace broken links in mlx5 guidedoc/guides/nics/mlx4.rst doc/guides/nics/mlx5.rst+5 -50 replies
3/5doc: correct name of BlueField-2 in mlx5 guidedoc/guides/compressdevs/mlx5.rst doc/guides/cryptodevs/mlx5.rst doc/guides/nics/mlx5.rst +1 more+11 -110 replies
4/5doc: add shared guide for mlx5 PMDsdoc/guides/compressdevs/mlx5.rst doc/guides/cryptodevs/mlx5.rst doc/guides/nics/mlx5.rst +4 more+662 -6520 replies
5/5doc: update doorbell mapping parameter name in mlx5 guidedoc/guides/nics/mlx5.rst doc/guides/platform/mlx5.rst drivers/common/mlx5/linux/mlx5_common_os.c +4 more+72 -463 replies

Reviews trailers per patch

All 5 patches have a Reviewed-by or Acked-by.

PatchRaslan DarawshehViacheslav Ovsiienko
1/5R-b A-b
2/5R-b A-b
3/5R-b A-b
4/5R-b A-b
5/5R-b A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v2 thread

Cover letter [PATCH v2 0/5] Refactor mlx5 guides

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/[email protected]/

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
Signature · 1 line
2.25.1