[dpdk-dev] [PATCH v2] eventdev: clarify nb_links and nb_unlinks description

[Jerin Jacob]

On Mon, Feb 13, 2017 at 09:52:53AM -0600, Gage Eads wrote:
> 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 <gage.eads at intel.com>

Acked-by: Jerin Jacob <jerin.jacob at caviumnetworks.com>

> ---
> Changes for v2:
>   - Clarify nb_links as well
> 
>  lib/librte_eventdev/rte_eventdev.h | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
> index c2f9310..eaf9dc6 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -1291,7 +1291,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
> @@ -1336,7 +1337,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
> -- 
> 2.7.4
>