From: Harry van Haaren Date: Wed, 8 Mar 2017 10:35:34 +0000 (+0000) Subject: eventdev: improve API doc for timeout ticks X-Git-Tag: spdx-start~3861 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=23cabf3017c3b9cbe737822e4e2c0dae6dce8348;p=dpdk.git eventdev: improve API doc for timeout ticks Improve the documentation of the return values of the rte_event_dequeue_timeout_ticks() function, adding a -ENOTSUP value for eventdevs that do not support waiting. Signed-off-by: Harry van Haaren Acked-by: Jerin Jacob --- diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h index 487635363b..4c879220c7 100644 --- a/lib/librte_eventdev/rte_eventdev.h +++ b/lib/librte_eventdev/rte_eventdev.h @@ -1158,7 +1158,9 @@ rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id, * * @return * - 0 on success. - * - <0 on failure. + * - -ENOTSUP if the device doesn't support timeouts + * - -EINVAL if *dev_id* is invalid or *timeout_ticks* is NULL + * - other values < 0 on failure. * * @see rte_event_dequeue_burst(), RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT * @see rte_event_dev_configure()