From 40401c5bcfa1f9709608a7c1b472100a76bbfb52 Mon Sep 17 00:00:00 2001 From: Jasvinder Singh Date: Wed, 14 Nov 2018 15:36:42 +0000 Subject: [PATCH] doc: announce API change for sched library There will be change in API functions because of mbuf sched field updates, outlined in deprecation note of mbuf->hash.sched. Signed-off-by: Jasvinder Singh Acked-by: Cristian Dumitrescu Acked-by: Reshma Pattan Acked-by: Mohammad Abdul Awal --- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 6bc5189eff..55a4c40898 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -48,6 +48,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()`` -- 2.20.1