doc: add deprecation notice for sched changes
diff mbox series

Message ID 1594895299-426202-1-git-send-email-savinay.dharmappa@intel.com
State Superseded
Headers show
Series
  • doc: add deprecation notice for sched changes
Related show

Checks

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

Commit Message

Savinay Dharmappa July 16, 2020, 10:28 a.m. UTC
Add deprecation note for making changes in data structures and APIs
in order to allow dynamic configuration of subport bandwidth profile.
These changes are aligned as suggested in the RFC[1].

https://mails.dpdk.org/archives/dev/2020-July/175161.html

Signed-off-by: Savinay Dharmappa <savinay.dharmappa@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index a58a179..d78a3a1 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -129,6 +129,12 @@  Deprecation Notices
   in "rte_sched.h". These changes are aligned to improvements suggested in the
   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
 
+* sched: To allow dynamic configuration of the subport bandwidth profile,
+  changes will be made to data structures ``rte_sched_subport_params``
+  ``rte_sched_port_params`` and new data structure, API fuctions will be
+  defined in "rte_sched.h". These changes are aligned as suggested in the
+  RFC https://mails.dpdk.org/archives/dev/2020-July/175161.html
+
 * metrics: The function ``rte_metrics_init`` will have a non-void return
   in order to notify errors instead of calling ``rte_exit``.