From: Stephen Hemminger <stephen@networkplumber.org>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: dev@dpdk.org
Subject: Re: [PATCH 0/4] rework mlx5 guide
Date: Fri, 18 Jul 2025 08:36:48 -0700 [thread overview]
Message-ID: <20250718083648.57333c97@hermes.local> (raw)
In-Reply-To: <20250717220912.376503-1-thomas@monjalon.net>
On Fri, 18 Jul 2025 00:05:40 +0200
Thomas Monjalon <thomas@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.
prev parent reply other threads:[~2025-07-18 15:42 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-17 22:05 Thomas Monjalon
2025-07-17 22:05 ` [PATCH 1/4] doc: simplify mlx5 devices lists Thomas Monjalon
2025-07-17 22:05 ` [PATCH 2/4] doc: add table styles for guides Thomas Monjalon
2025-07-17 22:05 ` [PATCH 3/4] doc: rework mlx5 guide per features Thomas Monjalon
2025-07-18 15:20 ` Stephen Hemminger
2025-07-17 22:05 ` [PATCH 4/4] doc: add testpmd command examples in mlx5 guide Thomas Monjalon
2025-07-18 15:36 ` Stephen Hemminger [this message]
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=20250718083648.57333c97@hermes.local \
--to=stephen@networkplumber.org \
--cc=dev@dpdk.org \
--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).