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

Nithin Dabilpuram nithind1988 at gmail.com
Fri May 1 19:16:22 CEST 2020

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.


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://mails.dpdk.org/archives/dev/2020-April/164970.html 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.

More information about the dev mailing list