From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCH] doc: commands changed in testpmd_funcs for ethertype filter Date: Wed, 21 Jan 2015 10:51:34 +0100 Message-ID: <8061560.oHjXtknKeu@xps13> References: <1421829050-9620-1-git-send-email-jingjing.wu@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7Bit Cc: dev-VfR2kkLFssw@public.gmane.org To: Jingjing Wu Return-path: In-Reply-To: <1421829050-9620-1-git-send-email-jingjing.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces-VfR2kkLFssw@public.gmane.org Sender: "dev" Hi Jingjing, Thanks for providing a patch quickly for the missing doc. I have a few comments. 2015-01-21 16:30, Jingjing Wu: > new commands for ethertype filter > - ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) > (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id) > > Signed-off-by: Jingjing Wu > --- > doc/guides/testpmd_app_ug/testpmd_funcs.rst | 46 +++++++---------------------- > 1 file changed, 11 insertions(+), 35 deletions(-) > > diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst > index be935c2..61a7f6d 100644 > --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst > +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst > @@ -1397,56 +1397,32 @@ add_ethertype_filter > > Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue. > > -add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue (queue_id) index (idx) > +ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id) > > The available information parameters are: > > * port_id: the port which the Ethertype filter assigned on. > > -* eth_value: the EtherType value want to match, > - for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid. > - > -* enable: user priority participates in the match. > - > -* disable: user priority doesn't participate in the match. > - > -* pri_value: user priority value that want to match. > - > -* queue_id : The receive queue associated with this EtherType filter > +* mac_addr: need compare destination mac address. is "need" needed? ;) mac_addr: compare destination mac address. > > -* index: the index of this EtherType filter > - > -Example: > - > -.. code-block:: console > +* mac_ignr: ignore destination mac address match. > > - testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0 > - Assign ARP packet to receive queue 3 > +* mac_address: destination mac address need to match. again, I would remove "need" mac_address: destination mac address to match. > > -remove_ethertype_filter > -~~~~~~~~~~~~~~~~~~~~~~~ > - > -Remove a L2 Ethertype filter > - > -remove_ethertype_filter (port_id) index (idx) > - > -get_ethertype_filter > -~~~~~~~~~~~~~~~~~~~~ > - > -Get and display a L2 Ethertype filter > +* ether_type: the EtherType value want to match, > + for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid. > > -get_ethertype_filter (port_id) index (idx) > +* queue_id : The receive queue associated with this EtherType filter. It is meaningless when deleting or dropping. Do you mean queue_id is optional? > > Example: > > .. code-block:: console > > - testpmd> get_ethertype_filter 0 index 0 > + testpmd> ethertype_filter 0 add mac_ignr ethertype 0x0806 fwd queue 3 > + add a rule to assign ARP packet to receive queue 3 You are adding a comment in the code-block. Not sure it is a good idea. > > - filter[0]: > - ethertype: 0x0806 > - priority: disable, 0 > - queue: 3 > + testpmd> ethertype_filter 0 del mac_ignr ethertype 0x0806 fwd queue 3 The indent is strange here. > + delete the rule to assign ARP packet to receive queue 3 > > add_2tuple_filter > ~~~~~~~~~~~~~~~~~ > -- Thomas