[dpdk-dev] [PATCH] eventdev: amend comments for nb_events_limit and new_event_threshold

[Nipun Gupta]

Updated the comments on 'nb_events_limit' of 'struct rte_event_dev_config'
and 'new_event_threshold' of 'struct rte_event_port_conf' for open system
configuration.

Signed-off-by: Nipun Gupta <nipun.gupta at nxp.com>
---
 lib/librte_eventdev/rte_eventdev.h | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index c2f9310..171e52e 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -404,11 +404,12 @@ struct rte_event_dev_config {
 	 * @see RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
 	 */
 	int32_t nb_events_limit;
-	/**< Applies to *closed system* event dev only. This field indicates a
-	 * limit to ethdev-like devices to limit the number of events injected
-	 * into the system to not overwhelm core-to-core events.
+	/**< In a *closed system* this field indicates a limit to ethdev-like
+	 * devices to limit the number of events injected into the system to
+	 * not overwhelm core-to-core events.
 	 * This value cannot exceed the *max_num_events* which previously
-	 * provided in rte_event_dev_info_get()
+	 * provided in rte_event_dev_info_get().
+	 * This should be set to '-1' for *open system*.
 	 */
 	uint8_t nb_event_queues;
 	/**< Number of event queues to configure on this device.
@@ -633,7 +634,8 @@ struct rte_event_port_conf {
 	 * can have a lower threshold so as not to overwhelm the device,
 	 * while ports used for worker pools can have a higher threshold.
 	 * This value cannot exceed the *nb_events_limit*
-	 * which previously supplied to rte_event_dev_configure()
+	 * which previously supplied to rte_event_dev_configure().
+	 * This should be set to '-1' for *open system*.
 	 */
 	uint8_t dequeue_depth;
 	/**< Configure number of bulk dequeues for this event port.
-- 
1.9.1