[dpdk-dev] [EXT] Re: [PATCH] doc: deprication notice to mark tm spec as experimental

[Nithin Dabilpuram]

On Tue, May 05, 2020 at 07:47:43AM +0100, Ray Kinsella wrote:
> External Email
> 
> ----------------------------------------------------------------------
> 
> 
> On 01/05/2020 18:16, Nithin Dabilpuram wrote:
> > From: Nithin Dabilpuram <ndabilpuram at marvell.com>
> > 
> > Based on the discussion in below 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://urldefense.proofpoint.com/v2/url?u=https-3A__mails.dpdk.org_archives_dev_2020-2DApril_164970.html&d=DwIDaQ&c=nKjWec2b6R0mOyPaz7xtfQ&r=FZ_tPCbgFOh18zwRPO9H0yDx8VW38vuapifdDfc8SFQ&m=fMY2AL-_MFowqy_OpcWEwioupC8kxy4GNU6R3LZP_2A&s=WCnFYbXTODzmkAWYDdBurNyAJ8Hxti2qkxXNnuoBic4&e= 
> > 
> > Adding deprication notice for the same in advance.
> > 
> > Signed-off-by: Nithin Dabilpuram <ndabilpuram at marvell.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 9 +++++++++
> >  1 file changed, 9 insertions(+)
> > 
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 1339f54..8c90ec9 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -118,3 +118,12 @@ 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: Based on the discussion in the thread
> > +  https://urldefense.proofpoint.com/v2/url?u=https-3A__mails.dpdk.org_archives_dev_2020-2DApril_164970.html&d=DwIDaQ&c=nKjWec2b6R0mOyPaz7xtfQ&r=FZ_tPCbgFOh18zwRPO9H0yDx8VW38vuapifdDfc8SFQ&m=fMY2AL-_MFowqy_OpcWEwioupC8kxy4GNU6R3LZP_2A&s=WCnFYbXTODzmkAWYDdBurNyAJ8Hxti2qkxXNnuoBic4&e=  it turns out that
> > +  all traffic manager API's in ``rte_tm.h`` were mistakenly made stable even
> > +  though the MAINTAINER's file and header file text mentions it to be still
> > +  experimental. Given that even now, both the maintainer and other contributor's
> > +  are inclined towards keeping those API's in experimental state till some more
> > +  releases in support of spec improvements, it is decided that all API's in
> > +  ``rte_tm.h`` will be marked back as experimental in v20.11 DPDK release.
> > 
> 
> Slightly wordy - suggest making it a small bit more concise as follows. 
> 
> * 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 detail, please see `the thread
>  <https://urldefense.proofpoint.com/v2/url?u=https-3A__mails.dpdk.org_archives_dev_2020-2DApril_164970.html&d=DwIDaQ&c=nKjWec2b6R0mOyPaz7xtfQ&r=FZ_tPCbgFOh18zwRPO9H0yDx8VW38vuapifdDfc8SFQ&m=fMY2AL-_MFowqy_OpcWEwioupC8kxy4GNU6R3LZP_2A&s=WCnFYbXTODzmkAWYDdBurNyAJ8Hxti2qkxXNnuoBic4&e= >`_.

Ack, will send v2.
> 
> Ray K