Re: [dpdk-dev] [PATCH v4 1/3] ethdev: modify rte API for single flow dump

[Thomas Monjalon <thomas@monjalon.net>]

14/04/2021 11:07, Haifei Luo:
> Hi Thomas,
>     I will remove it from prog_guide/rte_flow.rst. Is it okay ? Thank you.

This is more a question for Ori.
In case he is not available, yes I think it is better to skip
rte_flow.rst in this patch as it doesn't bring added value.

Note: please avoid top-post.



> From: Thomas Monjalon <thomas@monjalon.net> 
> 14/04/2021 10:41, Haifei Luo:
> > Previous implementations support dump all the flows. Add new arg 
> > rte_flow in rte_flow_dev_dump to dump one flow.
> >
> > Signed-off-by: Haifei Luo <haifeil@nvidia.com>
> > Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > Acked-by: Ori Kam <orika@nvidia.com>
> [...]
> > +Dump
> > +~~~~~
> > +
> > +Dump information for all or one flows.
> > +
> > +.. code-block:: c
> > +
> > +   int
> > +   rte_flow_dev_dump(uint16_t port_id, struct rte_flow *flow,
> > +                     FILE *file,
> > +                     struct rte_flow_error *error);
> > +
> > +Arguments:
> > +
> > +- ``port_id``: port identifier of Ethernet device.
> > +- ``flow``: flow rule handle to dump. NULL to dump all.
> > +- ``file``: a pointer to a file for output
> > +- ``error``: perform verbose error reporting if not NULL. PMDs 
> > +initialize
> > +  this structure in case of error only.
> > +
> > +Return values:
> > +
> > +- 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
> 
> I really don't understand why we continue duplicating rte_flow doxygen in the guide. Please stop.
> Do one good API description in doxygen,
> and describe only the big picture and how-to in the guide.