From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id DBD6EFA7D for ; Mon, 19 Dec 2016 21:44:11 +0100 (CET) Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP; 19 Dec 2016 12:44:09 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,375,1477983600"; d="scan'208";a="44884309" Received: from irsmsx106.ger.corp.intel.com ([163.33.3.31]) by fmsmga006.fm.intel.com with ESMTP; 19 Dec 2016 12:44:09 -0800 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.124]) by IRSMSX106.ger.corp.intel.com ([169.254.8.66]) with mapi id 14.03.0248.002; Mon, 19 Dec 2016 20:44:08 +0000 From: "Mcnamara, John" To: Adrien Mazarguil , "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH v3 25/25] doc: describe testpmd flow command Thread-Index: AQHSWiE5l2fDPllTmk6d1RPNTGOyB6EPun5Q Date: Mon, 19 Dec 2016 20:44:07 +0000 Message-ID: References: In-Reply-To: Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMjU4YzJlMTYtNTE4Ni00ODg2LTg2NTktMjk1NmMxZDRlOGI3IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IlhDVnNsaWxCQTVOZkI0TDNlNVVrVzhCU20xVkZNRVwvK2VoSEdhRUcwbGRjPSJ9 x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v3 25/25] doc: describe testpmd flow command X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 19 Dec 2016 20:44:12 -0000 > -----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 >=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