[PATCH] eventdev: fix event vector documentation typo

[Jerin Jacob]

On Fri, Oct 21, 2022 at 1:48 PM Mattias Rönnblom
<mattias.ronnblom at ericsson.com> wrote:
>
> The Eventdev guide had got the type of the rte_event_vector struct's
> u64s union field wrong.
>
> Fixes: 1cc44d409271 ("eventdev: introduce event vector capability")
> Cc: pbhagavatula at marvell.com
> Cc: stable at dpdk.org
>
> Signed-off-by: Mattias Rönnblom <mattias.ronnblom at ericsson.com>

Thanks, Squashed this change as

    doc: fix eventdev doc updates

    Fixed release notes for changes made in eventdev library.
    Also updated the eventdev guide had got the type of the
    rte_event_vector struct's u64s union field wrong.

    Fixes: 5fa63911e43b ("eventdev: replace padding type in event vector")
    Fixes: 0fbb55efa542 ("eventdev: add element offset to event vector")
    Fixes: d986276f9b72 ("eventdev: add prefix to public symbol")
    Fixes: 1cc44d409271 ("eventdev: introduce event vector capability")

    Signed-off-by: Pavan Nikhilesh <pbhagavatula at marvell.com>
    Signed-off-by: Mattias Rönnblom <mattias.ronnblom at ericsson.com>

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

diff --git a/doc/guides/prog_guide/eventdev.rst
b/doc/guides/prog_guide/eventdev.rst
index 8c13c5832c..2c83176846 100644
--- a/doc/guides/prog_guide/eventdev.rst
+++ b/doc/guides/prog_guide/eventdev.rst
@@ -85,7 +85,7 @@ flexibility in what the actual vector is.

 * ``struct rte_mbuf *mbufs[0]`` - An array of mbufs.
 * ``void *ptrs[0]`` - An array of pointers.
-* ``uint64_t *u64s[0]`` - An array of uint64_t elements.
+* ``uint64_t u64s[0]`` - An array of uint64_t elements.

 The size of the event vector is related to the total number of elements it is
 configured to hold, this is achieved by making `rte_event_vector` a variable
diff --git a/doc/guides/rel_notes/release_22_11.rst
b/doc/guides/rel_notes/release_22_11.rst
index 1c3daf141d..0d45043271 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -478,6 +478,9 @@ API Changes

 * raw/ifgpa: The function ``rte_pmd_ifpga_get_pci_bus`` has been removed.

+* eventdev: The function pointer definition ``eventdev_stop_flush_t`` is
+  renamed to ``rte_eventdev_stop_flush_t`` to avoid conflicts with application
+  symbols.

 ABI Changes
 -----------
@@ -520,6 +523,14 @@ ABI Changes
 * eventdev: Added ``weight`` and ``affinity`` fields
   to ``rte_event_queue_conf`` structure.

+* eventdev: The field ``*u64s`` in the structure ``rte_event_vector``
is replaced
+  with ``u64s`` as the field is supposed to hold array of uint64_t values.
+
+* eventdev: The structure ``rte_event_vector`` was updated to include a new bit
+  field ``elem_offset:12`` the bits are taken from the bitfield ``rsvd:15``.
+  The element offset defines the offset into the vector array at
+  which valid elements start.
+

> ---
>  doc/guides/prog_guide/eventdev.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/guides/prog_guide/eventdev.rst b/doc/guides/prog_guide/eventdev.rst
> index 8c13c5832c..2c83176846 100644
> --- a/doc/guides/prog_guide/eventdev.rst
> +++ b/doc/guides/prog_guide/eventdev.rst
> @@ -85,7 +85,7 @@ flexibility in what the actual vector is.
>
>  * ``struct rte_mbuf *mbufs[0]`` - An array of mbufs.
>  * ``void *ptrs[0]`` - An array of pointers.
> -* ``uint64_t *u64s[0]`` - An array of uint64_t elements.
> +* ``uint64_t u64s[0]`` - An array of uint64_t elements.
>
>  The size of the event vector is related to the total number of elements it is
>  configured to hold, this is achieved by making `rte_event_vector` a variable
> --
> 2.34.1
>