[dpdk-dev] [PATCH] doc: announce API and ABI change for ethdev

[Jerin Jacob]

-----Original Message-----
> Date: Fri, 4 Aug 2017 12:07:28 +0800
> From: Yuanhan Liu <yliu at fridaylinux.org>
> To: Zhiyong Yang <zhiyong.yang at intel.com>
> Cc: dev at dpdk.org, zhihong.wang at intel.com, john.mcnamara at intel.com,
>  oilvier.matz at 6wind.com, thomas at monjalon.net
> Subject: Re: [dpdk-dev] [PATCH] doc: announce API and ABI change for ethdev
> User-Agent: Mutt/1.5.24 (2015-08-30)
> 
> On Wed, Jul 12, 2017 at 03:58:46PM +0800, Zhiyong Yang wrote:
> >   This is an API/ABI change notice for DPDK 17.11 on redefinition of
> 
> Don't put 2 whitespace char indentation here.
> 
> > port_id. port_id is defined as uint8_t by now, which is just ranged
> > from 0 to 255. For more and more scenerioes, more than 256 devices are
> > needed to support for vdev scalability.
> > 
> >   It is necessary for redefinition of port_id to extend from 1 bytes
> > to 2 bytes. All ethdev APIs and use cases related to port_id will be
> > changed at the same time.
> > 
> > Signed-off-by: Zhiyong Yang <zhiyong.yang at intel.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 4 ++++
> >  1 file changed, 4 insertions(+)
> > 
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 257dcba..f265980 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -54,6 +54,10 @@ Deprecation Notices
> >    Target release for removal of the legacy API will be defined once most
> >    PMDs have switched to rte_flow.
> >  
> > +* ABI/API changes are planned for 17.11 in the "rte_eth_dev_data" structure.
> 
> That's for ABI only and you missed the API part. Meaning, you need also
> mention that all APIs have port_id parameter will be changed too.
> 
> Also, rte_eth_dev_data is not the only structure has ABI changes. There
> are few more (for instance, rte_port_ethdev.h). As said before, you don't
> have to list all of them, but at least you should not list one example
> only as it seems that's the only structure has ABI change.
> 
> > +  Change the definition of port_id from 8bits to 16bits in order to support
> > +  more than 256 devices in DPDK.
> 
> 8bits -> 8 bits. You might want to reword it further. Besides that, this
> change is indeed needed. Thus,
> 
> Acked-by: Yuanhan Liu <yliu at fridaylinux.org>

Acked-by: Jerin Jacob <jerin.jacob at caviumnetworks.com>


> 
> 	--yliu
> > +
> >  * librte_table: The ``key_mask`` parameter will be added to all the hash tables
> >    that currently do not have it, as well as to the hash compute function prototype.
> >    The non-"do-sig" versions of the hash tables will be removed
> > -- 
> > 2.9.3