diff mbox series

doc: deprecation notice for sched API change

Message ID 20181114153642.88575-1-jasvinder.singh@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series doc: deprecation notice for sched API change | expand

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS
ci/Intel-compilation success Compilation OK

Commit Message

Singh, Jasvinder Nov. 14, 2018, 3:36 p.m. UTC
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

Pattan, Reshma Nov. 16, 2018, 4:10 p.m. UTC | #1
> -----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>
Mohammad Abdul Awal Nov. 21, 2018, 9:39 a.m. UTC | #2
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>
Thomas Monjalon Nov. 24, 2018, 6:13 p.m. UTC | #3
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
diff mbox series

Patch

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()``