From mboxrd@z Thu Jan  1 00:00:00 1970
From: "Mcnamara, John" <john.mcnamara@intel.com>
Subject: Re: [PATCH v3 25/25] doc: describe testpmd flow command
Date: Mon, 19 Dec 2016 20:44:07 +0000
Message-ID: <B27915DBBA3421428155699D51E4CFE2026896B8@IRSMSX103.ger.corp.intel.com>
References: <cover.1481903839.git.adrien.mazarguil@6wind.com>
 <cover.1482168851.git.adrien.mazarguil@6wind.com>
 <fcc4d34589201dc8b64fb94bb71c04005b8a5a5a.1482168851.git.adrien.mazarguil@6wind.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
To: Adrien Mazarguil <adrien.mazarguil@6wind.com>, "dev@dpdk.org"
 <dev@dpdk.org>
Return-path: <dev-bounces@dpdk.org>
Received: from mga02.intel.com (mga02.intel.com [134.134.136.20])
 by dpdk.org (Postfix) with ESMTP id DBD6EFA7D
 for <dev@dpdk.org>; Mon, 19 Dec 2016 21:44:11 +0100 (CET)
In-Reply-To: <fcc4d34589201dc8b64fb94bb71c04005b8a5a5a.1482168851.git.adrien.mazarguil@6wind.com>
Content-Language: en-US
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>



> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Adrien Mazarguil
> Sent: Monday, December 19, 2016 5:49 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH v3 25/25] doc: describe testpmd flow command
>=20
> Document syntax, interaction with rte_flow and provide usage examples.
>=20
> Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
>=20
> ...
>
> +
> +- Check whether a flow rule can be created::
> +
> +   flow validate {port_id}
> +       [group {group_id}] [priority {level}] [ingress] [egress]
> +       pattern {item} [/ {item} [...]] / end
> +       actions {action} [/ {action} [...]] / end
> +
> +- Create a flow rule::
> +
> +   flow create {port_id}
> +       [group {group_id}] [priority {level}] [ingress] [egress]
> +       pattern {item} [/ {item} [...]] / end
> +       actions {action} [/ {action} [...]] / end
> +
> +- Destroy specific flow rules::
> +
> +   flow destroy {port_id} rule {rule_id} [...]
> +
> +- Destroy all flow rules::
> +
> +   flow flush {port_id}
> +

Just a note:

The verbs destroy and flush don't sound right here. Create/destroy are comm=
on
verbs pairs for objects but these actions are more like add/remove. I guess=
 the
names come from the underlying APIs which possibly are creating/freeing
objects/structures but maybe they should be called add/remove as well.

And flush generally applies to a pipeline or a queue. The action here is cl=
oser
to "remove all".

Probably not worth reworking at this stage if it hasn't bothered anyone els=
e.


> +underlying device in its current state but stops short of creating it.
> +It is bound to ``rte_flow_validate()``::
> +
> + flow validate {port_id}
> +     [group {group_id}] [priority {level}] [ingress] [egress]
> +     pattern {item} [/ {item} [...]] / end
> +     actions {action} [/ {action} [...]] / end
> +

Here and elsewhere the indentation should be the RST standard 3 spaces,
similar to the rest of the doc. This is only worth changing if you
do some other revision of this doc.

Otherwise very good documentation.

Acked-by: John McNamara <john.mcnamara@intel.com>