Re: [dpdk-dev] [PATCH v5 1/3] ethdev: dump single flow rule

[Haifei Luo <haifeil@nvidia.com>]

HI Thomas,
   #1,  okay. Will change the place for comments.
   #2,  yes, I can change the description.

Thank you so much.

-----Original Message-----
From: Thomas Monjalon <thomas@monjalon.net> 
Sent: Wednesday, April 14, 2021 6:33 PM
To: Haifei Luo <haifeil@nvidia.com>
Cc: dev@dpdk.org; Ori Kam <orika@nvidia.com>; Slava Ovsiienko <viacheslavo@nvidia.com>; Raslan Darawsheh <rasland@nvidia.com>; Xueming(Steven) Li <xuemingl@nvidia.com>; Haifei Luo <haifeil@nvidia.com>; ajit.khaparde@broadcom.com; Xiaoyun Li <xiaoyun.li@intel.com>; Matan Azrad <matan@nvidia.com>; Shahaf Shuler <shahafs@nvidia.com>; Jerin Jacob <jerinj@marvell.com>; Nithin Dabilpuram <ndabilpuram@marvell.com>; Kiran Kumar K <kirankumark@marvell.com>; Ferruh Yigit <ferruh.yigit@intel.com>; Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Subject: Re: [PATCH v5 1/3] ethdev: dump single flow rule

External email: Use caution opening links or attachments


14/04/2021 11:51, Haifei Luo:
> Previous implementations support dump all the flows. Add new arg 
> rte_flow in rte_flow_dev_dump to dump one flow.

Rewording:
The API supported dumping all the flow rules.
A parameter is added to allow dumping a specific flow rule.

> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -1837,13 +1837,16 @@ all flows with assistance of external tools.
>
>     .. code-block:: console
>
> -       testpmd> flow dump <port> <output_file>
> +       To dump all flows:
> +       testpmd> flow dump <port> all <output_file>
> +       and dump one flow:
> +       testpmd> flow dump <port> rule <rule_id> <output_file>

Comments should not be in the code block.

> --- a/lib/librte_ethdev/rte_flow.h
> +++ b/lib/librte_ethdev/rte_flow.h
> @@ -3232,6 +3232,8 @@ enum rte_flow_conv_op {
>   *
>   * @param[in] port_id
>   *    The port identifier of the Ethernet device.
> + * @param[in] flow
> + *   The pointer of flow rule to dump. Dump all rules if NULL.

Sorry for not making it explicit,
when fixing "rte flow" I thought you would replace it also above in the existing function description.

I think  "The pointer of" is useless in general but I'm OK if you want to keep it.
To Ferruh and Andrew: we could make the ethdev API description lighter and more pleasant to read.