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 <haif...@nvidia.com> > Acked-by: Ajit Khaparde <ajit.khapa...@broadcom.com> > Acked-by: Ori Kam <or...@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.