Re: [PATCH v2] doc: add mlx5 xstats send scheduling counters description

[Thomas Monjalon <thomas@monjalon.net>]

27/11/2024 01:36, Stephen Hemminger:
> On Thu, 31 Oct 2024 10:04:38 +0200
> Viacheslav Ovsiienko <viacheslavo@nvidia.com> wrote:
> 
> > The mlx5 provides the scheduling send on time capability.
> > To check the operating status of this feature the extended statistics
> > counters are provided. This patch adds the counter descriptions
> > and provides some meaningful information how to interpret
> > the counter values in runtime.
> > 
> > Signed-off-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
> > ---
> >  doc/guides/nics/mlx5.rst | 59 ++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 59 insertions(+)
> > 
> > diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> > index b5522d50c5..5db4aeda1b 100644
> > --- a/doc/guides/nics/mlx5.rst
> > +++ b/doc/guides/nics/mlx5.rst
> > @@ -2662,3 +2662,62 @@ Destroy GENEVE TLV parser for specific port::
> >  
> >  This command doesn't destroy the global list,
> >  For releasing options, ``flush`` command should be used.
> > +
> > +
> > +Extended Statistics Counters
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +Send Scheduling Extended Statistics Counters
> > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> It is great to see description of counters, it would be good if all drivers did
> this for xstats. There are some issues with the documentation that should be
> addressed in later update.
> 
> The section number is wrong. It ends up as a subset of the "Testpmd driver specific
> commands". It should be in the Statistics section.

I've moved it and converted the bullet list to a definition list.

> The section headings overall for this NIC guide need to be reorganized/reworded.
> Kind of mess now.

Yes this guide will be reworked.

Applied, thanks.