From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id A54A8A0613 for ; Fri, 27 Sep 2019 16:14:36 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 868D31BEA5; Fri, 27 Sep 2019 16:14:35 +0200 (CEST) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 7EE7E1BE84 for ; Fri, 27 Sep 2019 16:14:33 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 27 Sep 2019 07:14:32 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,555,1559545200"; d="scan'208";a="219788172" Received: from fmsmsx103.amr.corp.intel.com ([10.18.124.201]) by fmsmga002.fm.intel.com with ESMTP; 27 Sep 2019 07:14:32 -0700 Received: from fmsmsx157.amr.corp.intel.com (10.18.116.73) by FMSMSX103.amr.corp.intel.com (10.18.124.201) with Microsoft SMTP Server (TLS) id 14.3.439.0; Fri, 27 Sep 2019 07:14:32 -0700 Received: from hasmsx106.ger.corp.intel.com (10.184.198.20) by FMSMSX157.amr.corp.intel.com (10.18.116.73) with Microsoft SMTP Server (TLS) id 14.3.439.0; Fri, 27 Sep 2019 07:14:31 -0700 Received: from hasmsx114.ger.corp.intel.com ([169.254.14.116]) by HASMSX106.ger.corp.intel.com ([169.254.10.69]) with mapi id 14.03.0439.000; Fri, 27 Sep 2019 17:14:29 +0300 From: "Baran, MarcinX" To: "Richardson, Bruce" CC: "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT sample app guide Thread-Index: AQHVb4aPH+iU6RkPTUuDqU4O5+UUaKc/LXuAgABvC/A= Date: Fri, 27 Sep 2019 14:14:28 +0000 Message-ID: <06CDC4676D44784DA2DF9423D4B672BE15ECCCEA@HASMSX114.ger.corp.intel.com> References: <20190919093850.460-1-marcinx.baran@intel.com> <20190920073714.1314-1-marcinx.baran@intel.com> <20190920073714.1314-7-marcinx.baran@intel.com> <20190927103625.GF1847@bricha3-MOBL.ger.corp.intel.com> In-Reply-To: <20190927103625.GF1847@bricha3-MOBL.ger.corp.intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-version: 11.2.0.6 dlp-reaction: no-action x-originating-ip: [10.184.70.11] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT sample app guide 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" -----Original Message----- From: Bruce Richardson =20 Sent: Friday, September 27, 2019 12:36 PM To: Baran, MarcinX Cc: dev@dpdk.org Subject: Re: [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT sample app= guide On Fri, Sep 20, 2019 at 09:37:14AM +0200, Marcin Baran wrote: > Added guide for IOAT sample app usage and code description. >=20 > Signed-off-by: Marcin Baran > --- > doc/guides/sample_app_ug/index.rst | 1 + > doc/guides/sample_app_ug/intro.rst | 4 + > doc/guides/sample_app_ug/ioat.rst | 764=20 > +++++++++++++++++++++++++++++ > 3 files changed, 769 insertions(+) > create mode 100644 doc/guides/sample_app_ug/ioat.rst >=20 > diff --git a/doc/guides/sample_app_ug/index.rst=20 > b/doc/guides/sample_app_ug/index.rst > index f23f8f59e..a6a1d9e7a 100644 > --- a/doc/guides/sample_app_ug/index.rst > +++ b/doc/guides/sample_app_ug/index.rst > @@ -23,6 +23,7 @@ Sample Applications User Guides > ip_reassembly > kernel_nic_interface > keep_alive > + ioat > l2_forward_crypto > l2_forward_job_stats > l2_forward_real_virtual > diff --git a/doc/guides/sample_app_ug/intro.rst=20 > b/doc/guides/sample_app_ug/intro.rst > index 90704194a..74462312f 100644 > --- a/doc/guides/sample_app_ug/intro.rst > +++ b/doc/guides/sample_app_ug/intro.rst > @@ -91,6 +91,10 @@ examples are highlighted below. > forwarding, or ``l3fwd`` application does forwarding based on Internet > Protocol, IPv4 or IPv6 like a simple router. > =20 > +* :doc:`Hardware packet copying`: The Hardware packet copying, > + or ``ioatfwd`` application demonstrates how to use IOAT rawdev=20 > +driver for > + copying packets between two threads. > + > * :doc:`Packet Distributor`: The Packet Distributor > demonstrates how to distribute packets arriving on an Rx port to diffe= rent > cores for processing and transmission. > diff --git a/doc/guides/sample_app_ug/ioat.rst=20 > b/doc/guides/sample_app_ug/ioat.rst > new file mode 100644 > index 000000000..69621673b > --- /dev/null > +++ b/doc/guides/sample_app_ug/ioat.rst > @@ -0,0 +1,764 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2019 Intel Corporation. > + > +Sample Application of packet copying using Intel\ |reg| QuickData=20 > +Technology=20 > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > +=3D=3D=3D=3D=3D=3D=3D > + Title is too long, you can drop the "Sample Application" at minimum, since = this is part of the example applications guide document. Call the section "= Packet Copying Using ..." In order to get the proper (R) symbol, you also need to add an include to t= he file. Therefore add the following line just after the copyright: .. include:: /Bruce [Marcin] Dropped "Sample Application" and added include.