[PATCH 0/4] rework mlx5 guide

[Stephen Hemminger]

On Fri, 18 Jul 2025 00:05:40 +0200
Thomas Monjalon <thomas at monjalon.net> wrote:

> The main mlx5 doc (for net driver) is improved
> with better explanations, better organization, better readability,
> and will be a better skeleton for future detailed explanations.
> 
> Maayan Kashani (1):
>   doc: add testpmd command examples in mlx5 guide
> 
> Thomas Monjalon (3):
>   doc: simplify mlx5 devices lists
>   doc: add table styles for guides
>   doc: rework mlx5 guide per features
> 
>  doc/guides/custom.css                         |   42 +
>  doc/guides/nics/features/mlx5.ini             |    1 +
>  doc/guides/nics/mlx4.rst                      |    5 +-
>  doc/guides/nics/mlx5.rst                      | 4802 +++++++++++------
>  doc/guides/platform/mlx5.rst                  |   48 +-
>  doc/guides/prog_guide/ethdev/flow_offload.rst |    7 +-
>  doc/guides/sample_app_ug/flow_filtering.rst   |    2 +-
>  doc/guides/vdpadevs/mlx5.rst                  |   16 +-
>  8 files changed, 3334 insertions(+), 1589 deletions(-)
> 

Looks better, it would be good to look at the table of contents
(right column in html) to see if could be better in complex document
like this.

For example the Usage, dump flows, VF trusterd, etc all seem like
FAQ kind of answers and could go under one heading.

The section about statistics should also get headers reset
to the right level. The part about phy_ counters might be better
in limitations section. The Limitations should probably be at
a different section level, not stuck after live migration.

It would be good to explain a little more about "forked secondary
process". I think this is a general thing across all of DPDK
not MLX5 specific. Should this go in EAL?

The part about Rx/Tx tuning and Rx burst function might be better
together.