From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas.monjalon@6wind.com>
Subject: Re: [PATCH v7 1/5] lib/librte_ether: change function
	name of tunnel port config
Date: Wed, 09 Mar 2016 10:32:09 +0100
Message-ID: <4446254.25Q6ds7RWu@xps13>
References: <1452496044-17524-1-git-send-email-wenzhuo.lu@intel.com>
 <35564540.2poe2s7h25@xps13>
 <6A0DE07E22DDAD4C9103DF62FEBC0909034391B9@shsmsx102.ccr.corp.intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org
To: "Lu, Wenzhuo" <wenzhuo.lu@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wm0-f52.google.com (mail-wm0-f52.google.com [74.125.82.52])
 by dpdk.org (Postfix) with ESMTP id 5D21D29C8
 for <dev@dpdk.org>; Wed,  9 Mar 2016 10:33:49 +0100 (CET)
Received: by mail-wm0-f52.google.com with SMTP id l68so184145389wml.0
 for <dev@dpdk.org>; Wed, 09 Mar 2016 01:33:49 -0800 (PST)
In-Reply-To: <6A0DE07E22DDAD4C9103DF62FEBC0909034391B9@shsmsx102.ccr.corp.intel.com>
List-Id: patches and discussions about DPDK <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>

2016-03-09 01:25, Lu, Wenzhuo:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > 2016-03-09 00:53, Lu, Wenzhuo:
> > > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > > 2016-03-04 10:35, Wenzhuo Lu:
> > > > > The names of function for tunnel port configuration are not accurate.
> > > > > They're tunnel_add/del, better change them to tunnel_port_add/del.
> > > >
> > > > As a lot of ethdev API, it is really badly documented.
> > > >
> > > > Please explain why this renaming and let's try to reword the
> > > > doxygen:
> > > >  * Add UDP tunneling port of an Ethernet device for filtering a
> > > > specific
> > > >  * tunneling packet by UDP port number.
> > >
> > > As we discussed before, these APIs only change the UDP port value of the
> > tunnel.
> > > But according to their names, seems like they're trying to add/delete a whole
> > tunnel.
> > > The names don't tell us what the functions really do, so we want to change the
> > names.
> > 
> > Neither the comment nor the name explain what means filtering here.
> > I think we should explain more.
> > We add a port number and a protocol type. What is it made for?
> 
> Prot_type means the tunnel type, VxLAN, GENEVE.., actually it's rte_eth_tunnel_type.
> Udp_port means the UDP port value used for the specific type of tunnel.
> I'll add some comments in the structure.

OK but we really need you explain in the doxygen what the NIC is expected
to do with these informations. I think it's so clear in your head that you
don't think the users don't understand what the tunnel offloading means.