[dpdk-dev] doc: announce ABI change for struct rte_eth_conf

Message ID 1449457307-15206-1-git-send-email-jijiang.liu@intel.com (mailing list archive)
State Superseded, archived
Headers

Commit Message

Jijiang Liu Dec. 7, 2015, 3:01 a.m. UTC
  Announce ABI change for struct rte_eth_conf.

Signed-off-by: Jijiang Liu <jijiang.liu@intel.com>
---
 doc/guides/rel_notes/deprecation.rst |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
  

Comments

Thomas Monjalon Dec. 7, 2015, 3:16 a.m. UTC | #1
2015-12-07 11:01, Jijiang Liu:
> +* ABI changes are planned for struct rte_eth_conf in order to support
> +  tunneling packet configuration in unified tunneling API. The release 2.2 does not contain these ABI
> +  changes, but release 2.3 will, and no backwards compatibility is planned.

Please, more details would be appreciated.
We need to decide whether an ABI deprecation is the right choice.
  
Jijiang Liu Dec. 7, 2015, 3:30 a.m. UTC | #2
Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Monday, December 07, 2015 11:17 AM
> To: Liu, Jijiang
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: announce ABI change for struct
> rte_eth_conf
> 
> 2015-12-07 11:01, Jijiang Liu:
> > +* ABI changes are planned for struct rte_eth_conf in order to support
> > +  tunneling packet configuration in unified tunneling API. The release 2.2
> does not contain these ABI
> > +  changes, but release 2.3 will, and no backwards compatibility is planned.
> 
> Please, more details would be appreciated.
> We need to decide whether an ABI deprecation is the right choice.

* ABI changes are planned for struct rte_eth_conf in order to support 
  tunneling packet configuration in unified tunneling APIs, which is the rte_eth_dev_tunnel_configure
  (uint8_t port_id, uint16_t rx_q, uint16_t tx_q, rte_eth_tunnel_conf * tunnel_conf) API is planned to add. 
  and the 'tunnel_conf' shloud be stored in global 'rte_eth_conf'.
  The release 2.2 does not contain these ABI change, but release 2.3 will, and no backwards compatibility is planned.

Is it enough clear?
  
Thomas Monjalon Dec. 7, 2015, 3:40 a.m. UTC | #3
2015-12-07 03:30, Liu, Jijiang:
> Hi Thomas,
> 
> > -----Original Message-----
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > Sent: Monday, December 07, 2015 11:17 AM
> > To: Liu, Jijiang
> > Cc: dev@dpdk.org
> > Subject: Re: [dpdk-dev] [PATCH] doc: announce ABI change for struct
> > rte_eth_conf
> > 
> > 2015-12-07 11:01, Jijiang Liu:
> > > +* ABI changes are planned for struct rte_eth_conf in order to support
> > > +  tunneling packet configuration in unified tunneling API. The release 2.2
> > does not contain these ABI
> > > +  changes, but release 2.3 will, and no backwards compatibility is planned.
> > 
> > Please, more details would be appreciated.
> > We need to decide whether an ABI deprecation is the right choice.
> 
> * ABI changes are planned for struct rte_eth_conf in order to support 
>   tunneling packet configuration in unified tunneling APIs, which is the rte_eth_dev_tunnel_configure
>   (uint8_t port_id, uint16_t rx_q, uint16_t tx_q, rte_eth_tunnel_conf * tunnel_conf) API is planned to add. 
>   and the 'tunnel_conf' shloud be stored in global 'rte_eth_conf'.
>   The release 2.2 does not contain these ABI change, but release 2.3 will, and no backwards compatibility is planned.
> 
> Is it enough clear?

No, I think we need an explanation in the commit message of what is
the purpose of rte_eth_dev_tunnel_configure() and tunnel_conf.
Ideally, an RFC patch would help.
  
Jijiang Liu Dec. 7, 2015, 7:47 a.m. UTC | #4
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Monday, December 07, 2015 11:40 AM
> To: Liu, Jijiang
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: announce ABI change for struct
> rte_eth_conf
> 
> 2015-12-07 03:30, Liu, Jijiang:
> > Hi Thomas,
> >
> > > -----Original Message-----
> > > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > Sent: Monday, December 07, 2015 11:17 AM
> > > To: Liu, Jijiang
> > > Cc: dev@dpdk.org
> > > Subject: Re: [dpdk-dev] [PATCH] doc: announce ABI change for struct
> > > rte_eth_conf
> > >
> > > 2015-12-07 11:01, Jijiang Liu:
> > > > +* ABI changes are planned for struct rte_eth_conf in order to
> > > > +support
> > > > +  tunneling packet configuration in unified tunneling API. The
> > > > +release 2.2
> > > does not contain these ABI
> > > > +  changes, but release 2.3 will, and no backwards compatibility is
> planned.
> > >
> > > Please, more details would be appreciated.
> > > We need to decide whether an ABI deprecation is the right choice.
> >
> > * ABI changes are planned for struct rte_eth_conf in order to support
> >   tunneling packet configuration in unified tunneling APIs, which is the
> rte_eth_dev_tunnel_configure
> >   (uint8_t port_id, uint16_t rx_q, uint16_t tx_q, rte_eth_tunnel_conf *
> tunnel_conf) API is planned to add.
> >   and the 'tunnel_conf' shloud be stored in global 'rte_eth_conf'.
> >   The release 2.2 does not contain these ABI change, but release 2.3 will,
> and no backwards compatibility is planned.
> >
> > Is it enough clear?
> 
> No, I think we need an explanation in the commit message of what is the
> purpose of rte_eth_dev_tunnel_configure() and tunnel_conf.
Ok, will do.
> Ideally, an RFC patch would help.
I'm working  on RFC patch, but it probably will miss merge timeslot of this release.
  
Chilikin, Andrey Dec. 7, 2015, 10:42 a.m. UTC | #5
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Jijiang Liu
> Sent: Monday, December 7, 2015 3:02 AM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: announce ABI change for struct rte_eth_conf
> 
> Announce ABI change for struct rte_eth_conf.
> 
> Signed-off-by: Jijiang Liu <jijiang.liu@intel.com>
Acked-by: Andrey Chilikin <andrey.chilikin@intel.com>
  
Thomas Monjalon Dec. 7, 2015, 11:43 a.m. UTC | #6
2015-12-07 07:47, Liu, Jijiang:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > 2015-12-07 03:30, Liu, Jijiang:
> > > Hi Thomas,
> > >
> > > > -----Original Message-----
> > > > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > > Sent: Monday, December 07, 2015 11:17 AM
> > > > To: Liu, Jijiang
> > > > Cc: dev@dpdk.org
> > > > Subject: Re: [dpdk-dev] [PATCH] doc: announce ABI change for struct
> > > > rte_eth_conf
> > > >
> > > > 2015-12-07 11:01, Jijiang Liu:
> > > > > +* ABI changes are planned for struct rte_eth_conf in order to
> > > > > +support
> > > > > +  tunneling packet configuration in unified tunneling API. The
> > > > > +release 2.2
> > > > does not contain these ABI
> > > > > +  changes, but release 2.3 will, and no backwards compatibility is
> > planned.
> > > >
> > > > Please, more details would be appreciated.
> > > > We need to decide whether an ABI deprecation is the right choice.
> > >
> > > * ABI changes are planned for struct rte_eth_conf in order to support
> > >   tunneling packet configuration in unified tunneling APIs, which is the
> > rte_eth_dev_tunnel_configure
> > >   (uint8_t port_id, uint16_t rx_q, uint16_t tx_q, rte_eth_tunnel_conf *
> > tunnel_conf) API is planned to add.
> > >   and the 'tunnel_conf' shloud be stored in global 'rte_eth_conf'.
> > >   The release 2.2 does not contain these ABI change, but release 2.3 will,
> > and no backwards compatibility is planned.
> > >
> > > Is it enough clear?
> > 
> > No, I think we need an explanation in the commit message of what is the
> > purpose of rte_eth_dev_tunnel_configure() and tunnel_conf.
> Ok, will do.
> > Ideally, an RFC patch would help.
> I'm working  on RFC patch, but it probably will miss merge timeslot of this release.

A RFC patch may be incomplete. The API changes are enough.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1c7ab01..f50f0c7 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -19,3 +19,7 @@  Deprecation Notices
   and table action handlers will be updated:
   the pipeline parameter will be added, the packets mask parameter will be
   either removed (for input port action handler) or made input-only.
+
+* ABI changes are planned for struct rte_eth_conf in order to support
+  tunneling packet configuration in unified tunneling API. The release 2.2 does not contain these ABI
+  changes, but release 2.3 will, and no backwards compatibility is planned.