Skip to content

Commit

Permalink
eventdev: fix Doxygen processing of vector struct
Browse files Browse the repository at this point in the history
[ upstream commit f5746d3fa2f9f08179878c22a0ec1f598a7f15a1 ]

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: 1cc44d4 ("eventdev: introduce event vector capability")
Fixes: 3c83806 ("eventdev: introduce event vector Rx capability")
Fixes: 699155f ("eventdev: fix clang C++ include")

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
Acked-by: Jerin Jacob <jerinj@marvell.com>
  • Loading branch information
bruce-richardson authored and bluca committed Mar 13, 2024
1 parent ad39899 commit 7a45bfb
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions lib/eventdev/rte_eventdev.h
Original file line number Diff line number Diff line change
Expand Up @@ -1107,10 +1107,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. */
Expand Down Expand Up @@ -1139,7 +1137,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
Expand Down

0 comments on commit 7a45bfb

Please sign in to comment.