From patchwork Fri Feb 10 19:04:33 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Eads, Gage" X-Patchwork-Id: 20378 X-Patchwork-Delegate: thomas@monjalon.net 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 688B9591E; Fri, 10 Feb 2017 20:05:44 +0100 (CET) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 168955911 for ; Fri, 10 Feb 2017 20:05:42 +0100 (CET) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga105.fm.intel.com with ESMTP; 10 Feb 2017 11:05:42 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos; i="5.35,142,1484035200"; d="scan'208"; a="1105773860" Received: from txasoft-yocto.an.intel.com (HELO txasoft-yocto.an.intel.com.) ([10.123.72.111]) by fmsmga001.fm.intel.com with ESMTP; 10 Feb 2017 11:05:41 -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: Fri, 10 Feb 2017 13:04:33 -0600 Message-Id: <1486753473-26330-1-git-send-email-gage.eads@intel.com> X-Mailer: git-send-email 2.7.4 Subject: [dpdk-dev] [PATCH] eventdev: clarify 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_unlinks when passing a NULL pointer as the queues argument. Signed-off-by: Gage Eads Acked-by: Jerin Jacob --- 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. * * @return * The number of unlinks actually established. The return value can be less