-----Original Message----- > Date: Thu, 31 May 2018 15:23:42 -0500 > From: Honnappa Nagarahalli <honnappa.nagaraha...@arm.com> > To: jerin.ja...@caviumnetworks.com > CC: dev@dpdk.org, Honnappa Nagarahalli <honnappa.nagaraha...@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.nagaraha...@arm.com> > Reviewed-by: Gavin Hu <gavin...@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.ja...@caviumnetworks.com>
