From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jerin Jacob Subject: Re: [PATCH] eventdev: update doxygen Date: Wed, 6 Sep 2017 11:42:09 +0530 Message-ID: <20170906061208.GA2883@jerin> References: <1504646088-3476-1-git-send-email-timothy.mcdaniel@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Cc: dev@dpdk.org To: Tim McDaniel Return-path: Received: from NAM02-BL2-obe.outbound.protection.outlook.com (mail-bl2nam02on0082.outbound.protection.outlook.com [104.47.38.82]) by dpdk.org (Postfix) with ESMTP id 9DB4D3DC for ; Wed, 6 Sep 2017 08:12:33 +0200 (CEST) Content-Disposition: inline In-Reply-To: <1504646088-3476-1-git-send-email-timothy.mcdaniel@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" -----Original Message----- > Date: Tue, 5 Sep 2017 16:14:48 -0500 > From: Tim McDaniel > To: jerin.jacob@caviumnetworks.com > CC: dev@dpdk.org > Subject: [PATCH] eventdev: update doxygen It is better to update the log message with more appropriate comment. Something like eventdev: clarify .... usage > X-Mailer: git-send-email 2.7.4 > > Update doxygen to make it clear that RTE_EVENT_OP_FORWARD and > RTE_EVENT_OP_RELEASE may only be enqueued to the same port that the > original event was dequeued from. > > Signed-off-by: Tim McDaniel > --- > lib/librte_eventdev/rte_eventdev.h | 14 +++++++++++++- > 1 file changed, 13 insertions(+), 1 deletion(-) > > diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h > index 128bc52..117eeb0 100644 > --- a/lib/librte_eventdev/rte_eventdev.h > +++ b/lib/librte_eventdev/rte_eventdev.h > @@ -882,7 +882,10 @@ rte_event_dev_close(uint8_t dev_id); > #define RTE_EVENT_OP_FORWARD 1 > /**< The CPU use this operation to forward the event to different event queue or > * change to new application specific flow or schedule type to enable > - * pipelining > + * pipelining. > + * > + * RTE_EVENT_OP_FORWARD must only be enqueued to the same port that the This text is under RTE_EVENT_OP_FORWARD. IMO, No need to explicitly mention the RTE_EVENT_OP_FORWARD again. Other than that the content looks good. > + * event to be forwarded was dequeued from. > */ > #define RTE_EVENT_OP_RELEASE 2 > /**< Release the flow context associated with the schedule type. > @@ -912,6 +915,9 @@ rte_event_dev_close(uint8_t dev_id); > * or no scheduling context is held then this function may be an NOOP, > * depending on the implementation. > * > + * RTE_EVENT_OP_RELEASE must only be enqueued to the same port that the > + * event to be released was dequeued from. Same as above. With above changes: Acked-by: Jerin Jacob