[PATCH v2 06/11] eventdev: improve doxygen comments on configure struct

[Bruce Richardson]

On Tue, Jan 23, 2024 at 10:46:00AM +0100, Mattias Rönnblom wrote:
> On 2024-01-19 18:43, Bruce Richardson wrote:
> > General rewording and cleanup on the rte_event_dev_config structure.
> > Improved the wording of some sentences and created linked
> > cross-references out of the existing references to the dev_info
> > structure.
> > 
> > Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
> > ---
> >   lib/eventdev/rte_eventdev.h | 47 +++++++++++++++++++------------------
> >   1 file changed, 24 insertions(+), 23 deletions(-)
> > 
> > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
> > index c57c93a22e..4139ccb982 100644
> > --- a/lib/eventdev/rte_eventdev.h
> > +++ b/lib/eventdev/rte_eventdev.h
> > @@ -599,9 +599,9 @@ rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id,
> >   struct rte_event_dev_config {
> >   	uint32_t dequeue_timeout_ns;
> >   	/**< rte_event_dequeue_burst() timeout on this device.
> > -	 * This value should be in the range of *min_dequeue_timeout_ns* and
> > -	 * *max_dequeue_timeout_ns* which previously provided in
> > -	 * rte_event_dev_info_get()
> > +	 * This value should be in the range of @ref rte_event_dev_info.min_dequeue_timeout_ns and
> > +	 * @ref rte_event_dev_info.max_dequeue_timeout_ns returned by
> > +	 * @ref rte_event_dev_info_get()
> >   	 * The value 0 is allowed, in which case, default dequeue timeout used.
> >   	 * @see RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
> >   	 */
> > @@ -609,40 +609,41 @@ struct rte_event_dev_config {
> >   	/**< In a *closed system* this field is the limit on maximum number of
> >   	 * events that can be inflight in the eventdev at a given time. The
> >   	 * limit is required to ensure that the finite space in a closed system
> > -	 * is not overwhelmed. The value cannot exceed the *max_num_events*
> > -	 * as provided by rte_event_dev_info_get().
> > +	 * is not overwhelmed.
> 
> "overwhelmed" -> "exhausted"
> 
> > +	 * Once the limit has been reached, any enqueues of NEW events to the
> > +	 * system will fail.
> 
> While this is true, it's also a bit misleading. RTE_EVENT_OP_NEW events
> being backpressured is controlled by new_event_threshold on the level of the
> port.
> 

Right. Will remove this statement, and instead add a cross-reference to the
new_event_threshold setting at the end of the comment.

/Bruce