diff mbox

[dpdk-dev] eventdev: clarify nb_unlinks description

Message ID 1486753473-26330-1-git-send-email-gage.eads@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel compilation success Compilation OK

Commit Message

Eads, Gage Feb. 10, 2017, 7:04 p.m. UTC 
  This commit clarifies the usage of nb_unlinks when passing a NULL pointer
as the queues argument.

Signed-off-by: Gage Eads <gage.eads@intel.com>
---
 lib/librte_eventdev/rte_eventdev.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Jerin Jacob Feb. 11, 2017, 6:29 a.m. UTC | #1 
On Fri, Feb 10, 2017 at 01:04:33PM -0600, Gage Eads wrote:
> This commit clarifies the usage of nb_unlinks when passing a NULL pointer
> as the queues argument.
> 
> Signed-off-by: Gage Eads <gage.eads@intel.com>
> ---
>  lib/librte_eventdev/rte_eventdev.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
> index c2f9310..7b64532 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -1336,7 +1336,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.

Add similar description to rte_event_port_link too, With that,

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

>   *
>   * @return
>   * The number of unlinks actually established. The return value can be less
> -- 
> 2.7.4
>
diff mbox

Patch

diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index c2f9310..7b64532 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -1336,7 +1336,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