doc: deprecation notice for sched API change
Checks
Commit Message
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 <jasvinder.singh@intel.com>
Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
---
doc/guides/rel_notes/deprecation.rst | 5 +++++
1 file changed, 5 insertions(+)
Comments
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Jasvinder Singh
> Sent: Wednesday, November 14, 2018 3:37 PM
> To: dev@dpdk.org
> Cc: Dumitrescu, Cristian <cristian.dumitrescu@intel.com>
> Subject: [dpdk-dev] [PATCH] 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.
>
> Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Acked-by: Reshma Pattan <reshma.pattan@intel.com>
On 14/11/2018 15:36, Jasvinder Singh wrote:
> 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 <jasvinder.singh@intel.com>
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> ---
> 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 34b28234c..b54598d07 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -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()``
Acked-by: Mohammad Abdul Awal <mohammad.abdul.awal@intel.com>
21/11/2018 10:39, Mohammad Abdul Awal:
> On 14/11/2018 15:36, Jasvinder Singh wrote:
> > 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 <jasvinder.singh@intel.com>
> > Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> Acked-by: Reshma Pattan <reshma.pattan@intel.com>
> Acked-by: Mohammad Abdul Awal <mohammad.abdul.awal@intel.com>
Applied
@@ -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()``