From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by dpdk.org (Postfix) with ESMTP id 42A2F1BAD5 for ; Tue, 5 Jun 2018 18:31:34 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 05 Jun 2018 09:31:32 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.49,479,1520924400"; d="scan'208";a="61481375" Received: from irsmsx108.ger.corp.intel.com ([163.33.3.3]) by fmsmga001.fm.intel.com with ESMTP; 05 Jun 2018 09:31:31 -0700 Received: from irsmsx102.ger.corp.intel.com ([169.254.2.146]) by IRSMSX108.ger.corp.intel.com ([169.254.11.139]) with mapi id 14.03.0319.002; Tue, 5 Jun 2018 17:31:30 +0100 From: "Van Haaren, Harry" To: Jerin Jacob , Honnappa Nagarahalli CC: "dev@dpdk.org" Thread-Topic: [PATCH] doc/event: improve eventdev library documentation Thread-Index: AQHT+75886gYwTlrDE28c/pGWhgEtqRR2xfg Date: Tue, 5 Jun 2018 16:31:29 +0000 Message-ID: References: <1527798222-1873-1-git-send-email-honnappa.nagarahalli@arm.com> <20180604044217.GA2901@jerin> In-Reply-To: <20180604044217.GA2901@jerin> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNzIxNDkwNzYtYmU4YS00OTNlLThlNjAtNjg2ZWIzNzk2Mzg3IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiNDBOekFPamYwaXVuSVk0bWNINFB0cEMrN2Q1N0dsMmhuXC9kc1RRV2J5U1VmcHBoVVBUNkl4RkZKQmtVcEQwRnMifQ== x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.0.200.100 dlp-reaction: no-action x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH] doc/event: improve eventdev library documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 05 Jun 2018 16:31:35 -0000 > From: Jerin Jacob [mailto:jerin.jacob@caviumnetworks.com] > Sent: Monday, June 4, 2018 5:42 AM > To: Honnappa Nagarahalli > Cc: dev@dpdk.org; Van Haaren, Harry > Subject: Re: [PATCH] doc/event: improve eventdev library documentation >=20 > -----Original Message----- > > Date: Thu, 31 May 2018 15:23:42 -0500 > > From: Honnappa Nagarahalli > > To: jerin.jacob@caviumnetworks.com > > CC: dev@dpdk.org, Honnappa Nagarahalli > > 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 > > Reviewed-by: Gavin Hu > > --- >=20 > Changes looks good to me. >=20 > Adding Harry for this review as he is the original author of this file. Thanks Jerin, >> uint16_t nb_rx =3D rte_event_dequeue_burst(dev_id, worker_port_id1, even= ts, 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 occuranc= es of id1 ? With that you have my Acked-by: Harry van Haaren > > 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 > > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > > @@ -129,7 +130,7 @@ API Walk-through > > > > This section will introduce the reader to the eventdev API, showing ho= w > 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 st= ate > of the >=20 > 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. >=20 > > > > > > 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 @@ > > >=20 > License is missing >=20 > see doc/guides/prog_guide/img/architecture-overview.svg file as reference= . >=20 > With above changes: >=20 > Acked-by: Jerin Jacob