From: Gage Eads Date: Mon, 3 Apr 2017 12:35:49 +0000 (+0530) Subject: eventdev: clarify some parameter descriptions X-Git-Tag: spdx-start~3864 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=4f9cf0bc40e5a3434e978cdc2d15d61a34505ca2;p=dpdk.git eventdev: clarify some parameter descriptions This commit clarifies the usage of nb_links and nb_unlinks when passing a NULL pointer as the queues argument. Signed-off-by: Gage Eads Acked-by: Jerin Jacob --- diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h index b619160b3c..707398782b 100644 --- a/lib/librte_eventdev/rte_eventdev.h +++ b/lib/librte_eventdev/rte_eventdev.h @@ -1293,7 +1293,8 @@ rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[], * with RTE_EVENT_DEV_PRIORITY_NORMAL servicing priority * * @param nb_links - * The number of links to establish + * The number of links to establish. This parameter is ignored if queues is + * NULL. * * @return * The number of links actually established. The return value can be less than @@ -1338,7 +1339,8 @@ rte_event_port_link(uint8_t dev_id, uint8_t port_id, * event queue(s) from the event port *port_id*. * * @param nb_unlinks - * The number of unlinks to establish + * The number of unlinks to establish. This parameter is ignored if queues is + * NULL. * * @return * The number of unlinks actually established. The return value can be less