From patchwork Mon Feb 13 15:52:53 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Eads, Gage" X-Patchwork-Id: 20403 X-Patchwork-Delegate: bruce.richardson@intel.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id A739A1077; Mon, 13 Feb 2017 16:53:23 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 8A3EF98 for ; Mon, 13 Feb 2017 16:53:21 +0100 (CET) Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 13 Feb 2017 07:53:20 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.35,156,1484035200"; d="scan'208";a="224726051" Received: from txasoft-yocto.an.intel.com (HELO txasoft-yocto.an.intel.com.) ([10.123.72.111]) by fmsmga004.fm.intel.com with ESMTP; 13 Feb 2017 07:53:19 -0800 From: Gage Eads To: dev@dpdk.org Cc: jerin.jacob@caviumnetworks.com, bruce.richardson@intel.com, hemant.agrawal@nxp.com, harry.van.haaren@intel.com, nipun.gupta@nxp.com Date: Mon, 13 Feb 2017 09:52:53 -0600 Message-Id: <1487001173-25040-1-git-send-email-gage.eads@intel.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1486753473-26330-1-git-send-email-gage.eads@intel.com> References: <1486753473-26330-1-git-send-email-gage.eads@intel.com> Subject: [dpdk-dev] [PATCH v2] eventdev: clarify nb_links and nb_unlinks description X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- 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