[EXT] [PATCH v4 12/12] eventdev: fix doxygen processing of event vector struct
Pavan Nikhilesh Bhagavatula
pbhagavatula at marvell.com
Mon Feb 26 07:53:15 CET 2024
> The event vector struct was missing comments on two members, and also
> was inadvertently creating a local variable called "__rte_aligned" in
> the doxygen output.
>
> Correct the comment markers to fix the former issue, and fix the latter
> by putting "#ifdef __DOXYGEN" around the alignment constraint.
>
> Fixes: 1cc44d409271 ("eventdev: introduce event vector capability")
> Fixes: 3c838062b91f ("eventdev: introduce event vector Rx capability")
> Fixes: 699155f2d4e2 ("eventdev: fix clang C++ include")
> Cc: stable at dpdk.org
>
> Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
Acked-by: Pavan Nikhilesh <pbhagavatula at marvell.com>
> ---
> lib/eventdev/rte_eventdev.h | 10 ++++++----
> 1 file changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
> index 03748eb437..cf7d103a6c 100644
> --- a/lib/eventdev/rte_eventdev.h
> +++ b/lib/eventdev/rte_eventdev.h
> @@ -1358,10 +1358,8 @@ struct rte_event_vector {
> * port and queue of the mbufs in the vector
> */
> struct {
> - uint16_t port;
> - /* Ethernet device port id. */
> - uint16_t queue;
> - /* Ethernet device queue id. */
> + uint16_t port; /**< Ethernet device port id. */
> + uint16_t queue; /**< Ethernet device queue id. */
> };
> };
> /**< Union to hold common attributes of the vector array. */
> @@ -1390,7 +1388,11 @@ struct rte_event_vector {
> * vector array can be an array of mbufs or pointers or opaque u64
> * values.
> */
> +#ifndef __DOXYGEN__
> } __rte_aligned(16);
> +#else
> +};
> +#endif
>
> /* Scheduler type definitions */
> #define RTE_SCHED_TYPE_ORDERED 0
> --
> 2.40.1
More information about the stable
mailing list