[dpdk-dev] [PATCH v7 1/5] lib/librte_ether: change function name of tunnel port config

[Thomas Monjalon]

2016-03-09 01:25, Lu, Wenzhuo:
> From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com]
> > 2016-03-09 00:53, Lu, Wenzhuo:
> > > From: Thomas Monjalon [mailto:thomas.monjalon at 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.