[v2] doc: announce single-event enqueue/dequeue ABI change

Message ID 20230705111219.245869-1-mattias.ronnblom@ericsson.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] doc: announce single-event enqueue/dequeue ABI change |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Mattias Rönnblom July 5, 2023, 11:12 a.m. UTC
  Announce the removal of the single-event enqueue and dequeue
operations from the eventdev ABI.

Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>

---
PATCH v2: Fix commit subject prefix.
---
 doc/guides/rel_notes/deprecation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
  

Comments

Jerin Jacob July 5, 2023, 1 p.m. UTC | #1
On Wed, Jul 5, 2023 at 4:48 PM Mattias Rönnblom
<mattias.ronnblom@ericsson.com> wrote:
>
> Announce the removal of the single-event enqueue and dequeue
> operations from the eventdev ABI.
>
> Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>

Acked-by: Jerin Jacob <jerinj@marvell.com>


>
> ---
> PATCH v2: Fix commit subject prefix.
> ---
>  doc/guides/rel_notes/deprecation.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 66431789b0..ca192d838d 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -153,3 +153,11 @@ Deprecation Notices
>    The new port library API (functions rte_swx_port_*)
>    will gradually transition from experimental to stable status
>    starting with DPDK 23.07 release.
> +
> +* eventdev: The single-event (non-burst) enqueue and dequeue
> +  operations, used by static inline burst enqueue and dequeue
> +  functions in <rte_eventdev.h>, will be removed in DPDK 23.11. This
> +  simplification includes changing the layout and potentially also the
> +  size of the public rte_event_fp_ops struct, breaking the ABI. Since
> +  these functions are not called directly by the application, the API
> +  remains unaffected.
> --
> 2.34.1
>
  
Pavan Nikhilesh Bhagavatula July 5, 2023, 1:02 p.m. UTC | #2
> On Wed, Jul 5, 2023 at 4:48 PM Mattias Rönnblom
> <mattias.ronnblom@ericsson.com> wrote:
> >
> > Announce the removal of the single-event enqueue and dequeue
> > operations from the eventdev ABI.
> >
> > Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
> 
> Acked-by: Jerin Jacob <jerinj@marvell.com>

Acked-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> 
> 
> >
> > ---
> > PATCH v2: Fix commit subject prefix.
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 8 ++++++++
> >  1 file changed, 8 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> > index 66431789b0..ca192d838d 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -153,3 +153,11 @@ Deprecation Notices
> >    The new port library API (functions rte_swx_port_*)
> >    will gradually transition from experimental to stable status
> >    starting with DPDK 23.07 release.
> > +
> > +* eventdev: The single-event (non-burst) enqueue and dequeue
> > +  operations, used by static inline burst enqueue and dequeue
> > +  functions in <rte_eventdev.h>, will be removed in DPDK 23.11. This
> > +  simplification includes changing the layout and potentially also the
> > +  size of the public rte_event_fp_ops struct, breaking the ABI. Since
> > +  these functions are not called directly by the application, the API
> > +  remains unaffected.
> > --
> > 2.34.1
> >
  
Jerin Jacob July 26, 2023, 12:04 p.m. UTC | #3
On Wed, Jul 5, 2023 at 6:30 PM Jerin Jacob <jerinjacobk@gmail.com> wrote:
>
> On Wed, Jul 5, 2023 at 4:48 PM Mattias Rönnblom
> <mattias.ronnblom@ericsson.com> wrote:
> >
> > Announce the removal of the single-event enqueue and dequeue
> > operations from the eventdev ABI.
> >
> > Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
>
> Acked-by: Jerin Jacob <jerinj@marvell.com>

+ Techboard for review

>
>
> >
> > ---
> > PATCH v2: Fix commit subject prefix.
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 8 ++++++++
> >  1 file changed, 8 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 66431789b0..ca192d838d 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -153,3 +153,11 @@ Deprecation Notices
> >    The new port library API (functions rte_swx_port_*)
> >    will gradually transition from experimental to stable status
> >    starting with DPDK 23.07 release.
> > +
> > +* eventdev: The single-event (non-burst) enqueue and dequeue
> > +  operations, used by static inline burst enqueue and dequeue
> > +  functions in <rte_eventdev.h>, will be removed in DPDK 23.11. This
> > +  simplification includes changing the layout and potentially also the
> > +  size of the public rte_event_fp_ops struct, breaking the ABI. Since
> > +  these functions are not called directly by the application, the API
> > +  remains unaffected.
> > --
> > 2.34.1
> >
  
Thomas Monjalon July 28, 2023, 3:51 p.m. UTC | #4
05/07/2023 15:02, Pavan Nikhilesh Bhagavatula:
> > On Wed, Jul 5, 2023 at 4:48 PM Mattias Rönnblom
> > <mattias.ronnblom@ericsson.com> wrote:
> > >
> > > Announce the removal of the single-event enqueue and dequeue
> > > operations from the eventdev ABI.
> > >
> > > Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
> > 
> > Acked-by: Jerin Jacob <jerinj@marvell.com>
> 
> Acked-by: Pavan Nikhilesh <pbhagavatula@marvell.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 66431789b0..ca192d838d 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -153,3 +153,11 @@  Deprecation Notices
   The new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status
   starting with DPDK 23.07 release.
+
+* eventdev: The single-event (non-burst) enqueue and dequeue
+  operations, used by static inline burst enqueue and dequeue
+  functions in <rte_eventdev.h>, will be removed in DPDK 23.11. This
+  simplification includes changing the layout and potentially also the
+  size of the public rte_event_fp_ops struct, breaking the ABI. Since
+  these functions are not called directly by the application, the API
+  remains unaffected.