Skip to contentSkip to conversation

doc: deprecation notice for sched API change

PATCH Applied Jasvinder Singh 4 participants 4 messages Nov 14, 2018 – Nov 24, 2018

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: deprecation notice for sched API change

There will be change in API functions because of mbuf sched field updates, outlined in deprecation note of mbuf->hash.sched.

---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)
doc/guides/rel_notes/deprecation.rst +5 -0
index 34b28234c..b54598d07 100644
@@ -34,6 +34,11 @@ Deprecation Notices
   is defined in librte_sched in a non-generic way. The new generic format
   will contain: queue ID, traffic class, color. Field size will not change.
 
+* sched: Some API functions will change prototype due to the above
+  deprecation note for mbuf->hash.sched, e.g. rte_sched_port_pkt_write() and
+  rte_sched_port_pkt_read() will likely have an additional parameter
+  of type struct rte_sched_port.
+
 * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
   replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
   ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
Signature · 1 line
2.17.1
Acked-by on v1 1/1
#1 lore raw
Quoted 9 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of Jasvinder Singh
Sent: Wednesday, November 14, 2018 3:37 PM
To: [email protected]
Cc: Dumitrescu, Cristian <[email protected]>
Subject: [dpdk-dev] [PATCH] doc: deprecation notice for sched API change

Quoted 5 lines

There will be change in API functions because of mbuf sched field updates, outlined in deprecation note of mbuf->hash.sched.

Acked-by on v1 1/1
#2 lore raw
In reply to Jasvinder Singh
Quoted 15 lines · Jasvinder Singh

There will be change in API functions because of mbuf sched field updates, outlined in deprecation note of mbuf->hash.sched.

---
  doc/guides/rel_notes/deprecation.rst | 5 +++++
  1 file changed, 5 insertions(+)
doc/guides/rel_notes/deprecation.rst +0 -0
index 34b28234c..b54598d07 100644
@@ -34,6 +34,11 @@ Deprecation Notices
    is defined in librte_sched in a non-generic way. The new generic format

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 44

Quoted 10 lines
doc/guides/rel_notes/deprecation.rst +5 -0
    will contain: queue ID, traffic class, color. Field size will not change.
 
+* sched: Some API functions will change prototype due to the above
+  deprecation note for mbuf->hash.sched, e.g. rte_sched_port_pkt_write() and
+  rte_sched_port_pkt_read() will likely have an additional parameter
+  of type struct rte_sched_port.
+
  * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
    replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
    ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``