From: "Carrillo, Erik G" <erik.g.carrillo@intel.com>
To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>,
"Pavan Nikhilesh Bhagavatula" <pbhagavatula@marvell.com>
Cc: "Mcnamara, John" <john.mcnamara@intel.com>,
"Rao, Nikhil" <nikhil.rao@intel.com>,
"Gujjar, Abhinandan S" <abhinandan.gujjar@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH 2/2] doc: add notes regarding eventdev producer consumer dependency
Date: Tue, 5 Mar 2019 23:52:11 +0000 [thread overview]
Message-ID: <BE54F058557D9A4FAC1D84E2FC6D8757233BD7AD@fmsmsx115.amr.corp.intel.com> (raw)
In-Reply-To: <95f22f788e1197580ee3c87f0d0c03108c4f89d3.camel@marvell.com>
> -----Original Message-----
> From: Jerin Jacob Kollanukkaran [mailto:jerinj@marvell.com]
> Sent: Tuesday, March 5, 2019 9:16 AM
> To: Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com>
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Rao, Nikhil
> <nikhil.rao@intel.com>; Carrillo, Erik G <erik.g.carrillo@intel.com>; Gujjar,
> Abhinandan S <abhinandan.gujjar@intel.com>; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH 2/2] doc: add notes regarding eventdev
> producer consumer dependency
>
> On Wed, 2019-02-27 at 20:00 +0000, Pavan Nikhilesh Bhagavatula wrote:
> > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> >
> > EventDev i.e consumer needs to be started before starting the event
> > producers.
> > Update documentation of EventDev and EventDev adapters.
> >
>
>
> Adding all the eventdev adapter maintainers for the feedback.
> It looks good to me as it is an natural flow(i.e we need to start eventdev first
> to consume the adapter events)
>
>
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> > ---
> > doc/guides/prog_guide/event_crypto_adapter.rst | 5 +++++
> > doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 5 +++++
> > doc/guides/prog_guide/event_timer_adapter.rst | 5 +++++
> > doc/guides/prog_guide/eventdev.rst | 5 +++++
> > 4 files changed, 20 insertions(+)
> >
> > diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst
> > b/doc/guides/prog_guide/event_crypto_adapter.rst
> > index 9fe09c805..1e3eb7139 100644
> > --- a/doc/guides/prog_guide/event_crypto_adapter.rst
> > +++ b/doc/guides/prog_guide/event_crypto_adapter.rst
> > @@ -286,6 +286,11 @@ service function if one exists.
> >
> > rte_event_crypto_adapter_start(id, mode);
> >
> > +.. Note::
> > +
> > + The eventdev to which the event_crypto_adapter is connected
> > needs to
> > + be started before calling rte_event_crypto_adapter_start().
>
>
> IMO, It is better to add @note under the all the *_adapter_start() APIs to
> capture the notes on doxygen.
I agree that a @note under the *_adapter_start() APIs would be more discoverable, or perhaps it could be mentioned in both places. Looks good otherwise.
next prev parent reply other threads:[~2019-03-05 23:52 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-27 20:00 [dpdk-dev] [PATCH 1/2] app/eventdev: start event producers after eventdev is started Pavan Nikhilesh Bhagavatula
2019-02-27 20:00 ` [dpdk-dev] [PATCH 2/2] doc: add notes regarding eventdev producer consumer dependency Pavan Nikhilesh Bhagavatula
2019-03-05 15:15 ` Jerin Jacob Kollanukkaran
2019-03-05 23:52 ` Carrillo, Erik G [this message]
2019-03-06 5:32 ` Gujjar, Abhinandan S
2019-03-08 18:24 ` [dpdk-dev] [PATCH 1/2] app/eventdev: start event producers after eventdev is started Jerin Jacob Kollanukkaran
2019-03-11 7:59 ` [dpdk-dev] [PATCH v2 1/2] app/eventdev: start event producers after eventdev Pavan Nikhilesh Bhagavatula
2019-03-11 7:59 ` [dpdk-dev] [PATCH v2 2/2] doc: add notes about eventdev producer consumer dependency Pavan Nikhilesh Bhagavatula
2019-03-12 20:41 ` [dpdk-dev] [PATCH v3 1/3] app/eventdev: start event producers after eventdev Pavan Nikhilesh Bhagavatula
2019-03-12 20:41 ` [dpdk-dev] [PATCH v3 2/3] examples/eventdev: start ethdev after eth adapter setup Pavan Nikhilesh Bhagavatula
2019-03-13 13:10 ` Rao, Nikhil
2019-03-12 20:41 ` [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency Pavan Nikhilesh Bhagavatula
2019-03-13 22:22 ` Carrillo, Erik G
2019-03-13 22:22 ` Carrillo, Erik G
2019-03-14 16:17 ` Jerin Jacob Kollanukkaran
2019-03-14 16:17 ` Jerin Jacob Kollanukkaran
2019-03-14 5:03 ` Gujjar, Abhinandan S
2019-03-14 5:03 ` Gujjar, Abhinandan S
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=BE54F058557D9A4FAC1D84E2FC6D8757233BD7AD@fmsmsx115.amr.corp.intel.com \
--to=erik.g.carrillo@intel.com \
--cc=abhinandan.gujjar@intel.com \
--cc=dev@dpdk.org \
--cc=jerinj@marvell.com \
--cc=john.mcnamara@intel.com \
--cc=nikhil.rao@intel.com \
--cc=pbhagavatula@marvell.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).