From: Jerin Jacob <jerin.jacob@caviumnetworks.com>
To: Tim McDaniel <timothy.mcdaniel@intel.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH] eventdev: update doxygen
Date: Wed, 6 Sep 2017 11:42:09 +0530 [thread overview]
Message-ID: <20170906061208.GA2883@jerin> (raw)
In-Reply-To: <1504646088-3476-1-git-send-email-timothy.mcdaniel@intel.com>
-----Original Message-----
> Date: Tue, 5 Sep 2017 16:14:48 -0500
> From: Tim McDaniel <timothy.mcdaniel@intel.com>
> 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 <timothy.mcdaniel@intel.com>
> ---
> 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 <jerin.jacob@caviumnetworks.com>
next prev parent reply other threads:[~2017-09-06 6:12 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-05 21:14 Tim McDaniel
2017-09-06 6:12 ` Jerin Jacob [this message]
2017-09-06 15:42 ` [dpdk-dev] [PATCH v2] eventdev: clarify usage of forward and release ops Tim McDaniel
2017-09-11 8:29 ` Jerin Jacob
2017-09-15 12:44 ` Jerin Jacob
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170906061208.GA2883@jerin \
--to=jerin.jacob@caviumnetworks.com \
--cc=dev@dpdk.org \
--cc=timothy.mcdaniel@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).