[dpdk-dev] [PATCH] eventdev: improve API docs for timeout ticks

[Jerin Jacob]

On Wed, Mar 08, 2017 at 10:35:34AM +0000, Harry van Haaren wrote:
> 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 <harry.van.haaren at intel.com>
> Acked-by: Jerin Jacob <jerin.jacob at caviumnetworks.com>

Applied to dpdk-next-eventdev/master. Thanks.

> 
> ---
> 
> Discussion and previous Acked from:
> http://dpdk.org/ml/archives/dev/2017-March/059419.html
> ---
>  lib/librte_eventdev/rte_eventdev.h | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
> index 7073987..bb216b4 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()
> -- 
> 2.7.4
>