[v2] doc: deprication notice to mark tm spec as experimental

Message ID 20200505080734.30726-1-nithind1988@gmail.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] doc: deprication notice to mark tm spec as experimental |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Nithin Dabilpuram May 5, 2020, 8:07 a.m. UTC
  From: Nithin Dabilpuram <ndabilpuram@marvell.com>

Based on the discussion in mail thread, it is concluded that
all traffic manager API's (rte_tm.h) need to be marked experimental
till few more releases to support further improvements to spec.

https://mails.dpdk.org/archives/dev/2020-April/164970.html

Adding deprication notice for the same in advance.

Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Comments

Ray Kinsella May 5, 2020, 8:10 a.m. UTC | #1
On 05/05/2020 09:07, Nithin Dabilpuram wrote:
> From: Nithin Dabilpuram <ndabilpuram@marvell.com>
> 
> Based on the discussion in mail thread, it is concluded that
> all traffic manager API's (rte_tm.h) need to be marked experimental
> till few more releases to support further improvements to spec.
> 
> https://mails.dpdk.org/archives/dev/2020-April/164970.html
> 
> Adding deprication notice for the same in advance.
> 
> Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 1339f54..2c76f36 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -118,3 +118,10 @@ Deprecation Notices
>    Python 2 support will be completely removed in 20.11.
>    In 20.08, explicit deprecation warnings will be displayed when running
>    scripts with Python 2.
> +
> +* traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
> +  abi stable in the v19.11 release. The TM maintainer and other contributor's have
> +  agreed to keep the TM API's as experimental in expectation of additional spec
> +  improvements. Therefore, all API's in ``rte_tm.h`` will be marked back as
> +  experimental in v20.11 DPDK release. For more details, please see `the thread
> +  <https://mails.dpdk.org/archives/dev/2020-April/164970.html>`_.
> 

Acked-by: Ray Kinsella <mdr@ashroe.eu>
  
Cristian Dumitrescu May 5, 2020, 8:55 a.m. UTC | #2
> -----Original Message-----
> From: Nithin Dabilpuram <nithind1988@gmail.com>
> Sent: Tuesday, May 5, 2020 9:08 AM
> To: Yigit, Ferruh <ferruh.yigit@intel.com>; Richardson, Bruce
> <bruce.richardson@intel.com>; Dumitrescu, Cristian
> <cristian.dumitrescu@intel.com>; thomas@monjalon.net;
> bluca@debian.org; Singh, Jasvinder <jasvinder.singh@intel.com>;
> arybchenko@solarflare.com; Kinsella, Ray <ray.kinsella@intel.com>;
> nhorman@tuxdriver.com; ktraynor@redhat.com;
> david.marchand@redhat.com; Mcnamara, John
> <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; jerinj@marvell.com; kkanas@marvell.com; Nithin
> Dabilpuram <ndabilpuram@marvell.com>
> Subject: [PATCH v2] doc: deprication notice to mark tm spec as experimental
> 
> From: Nithin Dabilpuram <ndabilpuram@marvell.com>
> 
> Based on the discussion in mail thread, it is concluded that
> all traffic manager API's (rte_tm.h) need to be marked experimental
> till few more releases to support further improvements to spec.
> 
> https://mails.dpdk.org/archives/dev/2020-April/164970.html
> 
> Adding deprication notice for the same in advance.
> 
> Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 1339f54..2c76f36 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -118,3 +118,10 @@ Deprecation Notices
>    Python 2 support will be completely removed in 20.11.
>    In 20.08, explicit deprecation warnings will be displayed when running
>    scripts with Python 2.
> +
> +* traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly
> made
> +  abi stable in the v19.11 release. The TM maintainer and other contributor's
> have
> +  agreed to keep the TM API's as experimental in expectation of additional
> spec
> +  improvements. Therefore, all API's in ``rte_tm.h`` will be marked back as
> +  experimental in v20.11 DPDK release. For more details, please see `the
> thread
> +  <https://mails.dpdk.org/archives/dev/2020-April/164970.html>`_.
> --
> 2.8.4

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
  
Jerin Jacob May 21, 2020, 10:49 a.m. UTC | #3
On Tue, May 5, 2020 at 2:25 PM Dumitrescu, Cristian
<cristian.dumitrescu@intel.com> wrote:
>
>
>
> > -----Original Message-----
> > From: Nithin Dabilpuram <nithind1988@gmail.com>
> > Sent: Tuesday, May 5, 2020 9:08 AM
> > To: Yigit, Ferruh <ferruh.yigit@intel.com>; Richardson, Bruce
> > <bruce.richardson@intel.com>; Dumitrescu, Cristian
> > <cristian.dumitrescu@intel.com>; thomas@monjalon.net;
> > bluca@debian.org; Singh, Jasvinder <jasvinder.singh@intel.com>;
> > arybchenko@solarflare.com; Kinsella, Ray <ray.kinsella@intel.com>;
> > nhorman@tuxdriver.com; ktraynor@redhat.com;
> > david.marchand@redhat.com; Mcnamara, John
> > <john.mcnamara@intel.com>; Kovacevic, Marko
> > <marko.kovacevic@intel.com>
> > Cc: dev@dpdk.org; jerinj@marvell.com; kkanas@marvell.com; Nithin
> > Dabilpuram <ndabilpuram@marvell.com>
> > Subject: [PATCH v2] doc: deprication notice to mark tm spec as experimental
> >
> > From: Nithin Dabilpuram <ndabilpuram@marvell.com>
> >
> > Based on the discussion in mail thread, it is concluded that
> > all traffic manager API's (rte_tm.h) need to be marked experimental
> > till few more releases to support further improvements to spec.
> >
> > https://mails.dpdk.org/archives/dev/2020-April/164970.html
> >
> > Adding deprication notice for the same in advance.
> >
> > Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 7 +++++++
> >  1 file changed, 7 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > index 1339f54..2c76f36 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -118,3 +118,10 @@ Deprecation Notices
> >    Python 2 support will be completely removed in 20.11.
> >    In 20.08, explicit deprecation warnings will be displayed when running
> >    scripts with Python 2.
> > +
> > +* traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly
> > made
> > +  abi stable in the v19.11 release. The TM maintainer and other contributor's
> > have
> > +  agreed to keep the TM API's as experimental in expectation of additional
> > spec
> > +  improvements. Therefore, all API's in ``rte_tm.h`` will be marked back as
> > +  experimental in v20.11 DPDK release. For more details, please see `the
> > thread
> > +  <https://mails.dpdk.org/archives/dev/2020-April/164970.html>`_.
> > --
> > 2.8.4
>
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Acked-by: Jerin Jacob <jerinj@marvell.com>


>
  
Nithin Dabilpuram May 24, 2020, 8:58 p.m. UTC | #4
Hi Thomas,

Can this be merged as it was discussed and agreed long back.

--
Nithin

On Thu, May 21, 2020, 16:19 Jerin Jacob <jerinjacobk@gmail.com> wrote:

> On Tue, May 5, 2020 at 2:25 PM Dumitrescu, Cristian
> <cristian.dumitrescu@intel.com> wrote:
> >
> >
> >
> > > -----Original Message-----
> > > From: Nithin Dabilpuram <nithind1988@gmail.com>
> > > Sent: Tuesday, May 5, 2020 9:08 AM
> > > To: Yigit, Ferruh <ferruh.yigit@intel.com>; Richardson, Bruce
> > > <bruce.richardson@intel.com>; Dumitrescu, Cristian
> > > <cristian.dumitrescu@intel.com>; thomas@monjalon.net;
> > > bluca@debian.org; Singh, Jasvinder <jasvinder.singh@intel.com>;
> > > arybchenko@solarflare.com; Kinsella, Ray <ray.kinsella@intel.com>;
> > > nhorman@tuxdriver.com; ktraynor@redhat.com;
> > > david.marchand@redhat.com; Mcnamara, John
> > > <john.mcnamara@intel.com>; Kovacevic, Marko
> > > <marko.kovacevic@intel.com>
> > > Cc: dev@dpdk.org; jerinj@marvell.com; kkanas@marvell.com; Nithin
> > > Dabilpuram <ndabilpuram@marvell.com>
> > > Subject: [PATCH v2] doc: deprication notice to mark tm spec as
> experimental
> > >
> > > From: Nithin Dabilpuram <ndabilpuram@marvell.com>
> > >
> > > Based on the discussion in mail thread, it is concluded that
> > > all traffic manager API's (rte_tm.h) need to be marked experimental
> > > till few more releases to support further improvements to spec.
> > >
> > > https://mails.dpdk.org/archives/dev/2020-April/164970.html
> > >
> > > Adding deprication notice for the same in advance.
> > >
> > > Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> > > ---
> > >  doc/guides/rel_notes/deprecation.rst | 7 +++++++
> > >  1 file changed, 7 insertions(+)
> > >
> > > diff --git a/doc/guides/rel_notes/deprecation.rst
> > > b/doc/guides/rel_notes/deprecation.rst
> > > index 1339f54..2c76f36 100644
> > > --- a/doc/guides/rel_notes/deprecation.rst
> > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > @@ -118,3 +118,10 @@ Deprecation Notices
> > >    Python 2 support will be completely removed in 20.11.
> > >    In 20.08, explicit deprecation warnings will be displayed when
> running
> > >    scripts with Python 2.
> > > +
> > > +* traffic manager: All traffic manager API's in ``rte_tm.h`` were
> mistakenly
> > > made
> > > +  abi stable in the v19.11 release. The TM maintainer and other
> contributor's
> > > have
> > > +  agreed to keep the TM API's as experimental in expectation of
> additional
> > > spec
> > > +  improvements. Therefore, all API's in ``rte_tm.h`` will be marked
> back as
> > > +  experimental in v20.11 DPDK release. For more details, please see
> `the
> > > thread
> > > +  <https://mails.dpdk.org/archives/dev/2020-April/164970.html>`_.
> > > --
> > > 2.8.4
> >
> > Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> Acked-by: Jerin Jacob <jerinj@marvell.com>
>
>
> >
>
  
Thomas Monjalon May 24, 2020, 11:33 p.m. UTC | #5
> > > From: Nithin Dabilpuram <ndabilpuram@marvell.com>
> > >
> > > Based on the discussion in mail thread, it is concluded that
> > > all traffic manager API's (rte_tm.h) need to be marked experimental
> > > till few more releases to support further improvements to spec.
> > >
> > > https://mails.dpdk.org/archives/dev/2020-April/164970.html
> > >
> > > Adding deprication notice for the same in advance.
> > >
> > > Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> > > ---
> > > +* traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly
> > > made
> > > +  abi stable in the v19.11 release. The TM maintainer and other contributor's
> > > have
> > > +  agreed to keep the TM API's as experimental in expectation of additional
> > > spec
> > > +  improvements. Therefore, all API's in ``rte_tm.h`` will be marked back as
> > > +  experimental in v20.11 DPDK release. For more details, please see `the
> > > thread
> > > +  <https://mails.dpdk.org/archives/dev/2020-April/164970.html>`_.
> >
> > Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> Acked-by: Jerin Jacob <jerinj@marvell.com>
Acked-by: Ray Kinsella <mdr@ashroe.eu>

Applied, thanks
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1339f54..2c76f36 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -118,3 +118,10 @@  Deprecation Notices
   Python 2 support will be completely removed in 20.11.
   In 20.08, explicit deprecation warnings will be displayed when running
   scripts with Python 2.
+
+* traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
+  abi stable in the v19.11 release. The TM maintainer and other contributor's have
+  agreed to keep the TM API's as experimental in expectation of additional spec
+  improvements. Therefore, all API's in ``rte_tm.h`` will be marked back as
+  experimental in v20.11 DPDK release. For more details, please see `the thread
+  <https://mails.dpdk.org/archives/dev/2020-April/164970.html>`_.