From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jerin Jacob Subject: Re: [PATCH] eventdev: improve API docs for timeout ticks Date: Mon, 13 Mar 2017 14:18:53 +0530 Message-ID: <20170313084852.vpskvkohq3bh47km@localhost.localdomain> References: <1487343252-16092-2-git-send-email-harry.van.haaren@intel.com> <1488969334-93696-1-git-send-email-harry.van.haaren@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Cc: dev@dpdk.org To: Harry van Haaren Return-path: Received: from NAM02-BL2-obe.outbound.protection.outlook.com (mail-bl2nam02on0056.outbound.protection.outlook.com [104.47.38.56]) by dpdk.org (Postfix) with ESMTP id 143F1A10 for ; Mon, 13 Mar 2017 09:49:14 +0100 (CET) Content-Disposition: inline In-Reply-To: <1488969334-93696-1-git-send-email-harry.van.haaren@intel.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 > Acked-by: Jerin Jacob 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 >