From: Jerin Jacob <jerin.jacob@caviumnetworks.com>
To: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Cc: dev@dpdk.org, harry.van.haaren@intel.com
Subject: Re: [dpdk-dev] [PATCH] doc/event: improve eventdev library documentation
Date: Mon, 4 Jun 2018 10:12:19 +0530 [thread overview]
Message-ID: <20180604044217.GA2901@jerin> (raw)
In-Reply-To: <1527798222-1873-1-git-send-email-honnappa.nagarahalli@arm.com>
-----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.
> 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-04 4:42 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 [this message]
2018-06-05 16:31 ` Van Haaren, Harry
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=20180604044217.GA2901@jerin \
--to=jerin.jacob@caviumnetworks.com \
--cc=dev@dpdk.org \
--cc=harry.van.haaren@intel.com \
--cc=honnappa.nagarahalli@arm.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).