From: "Van Haaren, Harry" <harry.van.haaren@intel.com>
To: Jerin Jacob <jerin.jacob@caviumnetworks.com>,
Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc/event: improve eventdev library documentation
Date: Tue, 5 Jun 2018 16:31:29 +0000 [thread overview]
Message-ID: <E923DB57A917B54B9182A2E928D00FA65E257536@IRSMSX102.ger.corp.intel.com> (raw)
In-Reply-To: <20180604044217.GA2901@jerin>
> From: Jerin Jacob [mailto:jerin.jacob@caviumnetworks.com]
> Sent: Monday, June 4, 2018 5:42 AM
> To: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> Cc: dev@dpdk.org; Van Haaren, Harry <harry.van.haaren@intel.com>
> Subject: Re: [PATCH] doc/event: improve eventdev library documentation
>
> -----Original Message-----
> > Date: Thu, 31 May 2018 15:23:42 -0500
> > From: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> > To: jerin.jacob@caviumnetworks.com
> > CC: dev@dpdk.org, Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> > Subject: [PATCH] doc/event: improve eventdev library documentation
> > X-Mailer: git-send-email 2.7.4
> >
> > Add small amount of additional code, use consistent variable names
> > across code blocks, change the image to represent queues and
> > CPU cores intuitively. These help improve the eventdev library
> > documentation.
> >
> > Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> > Reviewed-by: Gavin Hu <gavin.hu@arm.com>
> > ---
>
> Changes looks good to me.
>
> Adding Harry for this review as he is the original author of this file.
Thanks Jerin,
>> uint16_t nb_rx = rte_event_dequeue_burst(dev_id, worker_port_id1, events, BATCH_SIZE, timeout);
why is the worker port variable named "worker_port_id1"? Previously it was just worker_port_id.
I think just worker_port_id makes more sense, perhaps update the 2 occurances of id1 ?
With that you have my
Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
> > doc/guides/prog_guide/eventdev.rst | 55 +-
> > doc/guides/prog_guide/img/eventdev_usage.svg | 1518 +++++++++------------
> -----
> > 2 files changed, 570 insertions(+), 1003 deletions(-)
> >
> > diff --git a/doc/guides/prog_guide/eventdev.rst
> b/doc/guides/prog_guide/eventdev.rst
> > index ce19997..0203d9e 100644
> > --- a/doc/guides/prog_guide/eventdev.rst
> > +++ b/doc/guides/prog_guide/eventdev.rst
> > @@ -1,5 +1,6 @@
> > .. SPDX-License-Identifier: BSD-3-Clause
> > Copyright(c) 2017 Intel Corporation.
> > + Copyright(c) 2018 Arm Limited.
> >
> > Event Device Library
> > ====================
> > @@ -129,7 +130,7 @@ API Walk-through
> >
> > This section will introduce the reader to the eventdev API, showing how
> to
> > create and configure an eventdev and use it for a two-stage atomic
> pipeline
> > -with a single core for TX. The diagram below shows the final state of the
> > +with one core each for RX and TX. The diagram below shows the final state
> of the
>
> I think, we can mention the usage of RX and TX core are API illustration
> purpose
> only, In the real case, it is abstracted using Eventdev - Ethdev adapters
> to hide the difference between various eventdev capabilities to Rx or Tx the
> packets.
> or something on similar lines.
>
> >
> >
> > Egress of Events
> > diff --git a/doc/guides/prog_guide/img/eventdev_usage.svg
> b/doc/guides/prog_guide/img/eventdev_usage.svg
> > index 7765649..b0792dc 100644
> > --- a/doc/guides/prog_guide/img/eventdev_usage.svg
> > +++ b/doc/guides/prog_guide/img/eventdev_usage.svg
> > @@ -1,994 +1,546 @@
> > <?xml version="1.0" encoding="UTF-8" standalone="no"?>
>
> License is missing
>
> see doc/guides/prog_guide/img/architecture-overview.svg file as reference.
>
> With above changes:
>
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
next prev parent reply other threads:[~2018-06-05 16:31 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-31 20:23 Honnappa Nagarahalli
2018-06-04 4:42 ` Jerin Jacob
2018-06-05 16:31 ` Van Haaren, Harry [this message]
2018-06-05 20:32 ` Honnappa Nagarahalli
2018-06-05 23:45 ` Jerin Jacob
2018-06-06 1:27 ` Honnappa Nagarahalli
2018-06-06 1:44 ` Honnappa Nagarahalli
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=E923DB57A917B54B9182A2E928D00FA65E257536@IRSMSX102.ger.corp.intel.com \
--to=harry.van.haaren@intel.com \
--cc=dev@dpdk.org \
--cc=honnappa.nagarahalli@arm.com \
--cc=jerin.jacob@caviumnetworks.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).