DPDK patches and discussions
 help / color / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: Marcin Baran <marcinx.baran@intel.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT sample app guide
Date: Fri, 27 Sep 2019 11:36:25 +0100
Message-ID: <20190927103625.GF1847@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <20190920073714.1314-7-marcinx.baran@intel.com>

On Fri, Sep 20, 2019 at 09:37:14AM +0200, Marcin Baran wrote:
> Added guide for IOAT sample app usage and
> code description.
> 
> Signed-off-by: Marcin Baran <marcinx.baran@intel.com>
> ---
>  doc/guides/sample_app_ug/index.rst |   1 +
>  doc/guides/sample_app_ug/intro.rst |   4 +
>  doc/guides/sample_app_ug/ioat.rst  | 764 +++++++++++++++++++++++++++++
>  3 files changed, 769 insertions(+)
>  create mode 100644 doc/guides/sample_app_ug/ioat.rst
> 
> diff --git a/doc/guides/sample_app_ug/index.rst 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 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.
>  
> +* :doc:`Hardware packet copying<ioat>`: The Hardware packet copying,
> +  or ``ioatfwd`` application demonstrates how to use IOAT rawdev driver for
> +  copying packets between two threads.
> +
>  * :doc:`Packet Distributor<dist_app>`: The Packet Distributor
>    demonstrates how to distribute packets arriving on an Rx port to different
>    cores for processing and transmission.
> diff --git a/doc/guides/sample_app_ug/ioat.rst 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 Technology
> +============================================================================
> +

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
the file. Therefore add the following line just after the copyright:

.. include:: <isonum.txt>

/Bruce

  reply index

Thread overview: 76+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-09  8:29 [dpdk-dev] [PATCH] examples/ioat: create sample app on ioat driver usage Marcin Baran
2019-09-09 13:12 ` Aaron Conole
2019-09-09 13:58   ` Bruce Richardson
2019-09-12  9:52 ` Bruce Richardson
2019-09-12 12:18   ` Baran, MarcinX
2019-09-13 14:39 ` [dpdk-dev] [PATCH v2 0/6] examples/ioat: " Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 1/6] examples/ioat: create " Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-13 14:39   ` [dpdk-dev] [PATCH v2 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-09-13 18:45   ` [dpdk-dev] [PATCH v2 0/6] examples/ioat: sample app on ioat driver usage Aaron Conole
2019-09-16  9:42     ` Baran, MarcinX
2019-09-19  9:19       ` Aaron Conole
2019-09-18  9:11   ` [dpdk-dev] [PATCH v3 " Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 1/6] examples/ioat: create " Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-18  9:11     ` [dpdk-dev] [PATCH v3 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-09-19  9:38     ` [dpdk-dev] [PATCH v4 0/6] examples/ioat: sample app on ioat driver usage Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 1/6] examples/ioat: create " Marcin Baran
2019-09-19 14:44         ` Bruce Richardson
2019-09-19 14:46           ` Baran, MarcinX
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-19  9:38       ` [dpdk-dev] [PATCH v4 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-09-20  7:37       ` [dpdk-dev] [PATCH v5 0/6] examples/ioat: sample app on ioat driver usage Marcin Baran
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 1/6] examples/ioat: create " Marcin Baran
2019-09-27  9:58           ` Bruce Richardson
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-27 10:01           ` Bruce Richardson
2019-09-27 14:01             ` Baran, MarcinX
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-27 10:05           ` Bruce Richardson
2019-09-27 14:03             ` Baran, MarcinX
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-27 10:08           ` Bruce Richardson
2019-09-27 14:03             ` Baran, MarcinX
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-27 10:12           ` Bruce Richardson
2019-09-27 14:04             ` Baran, MarcinX
2019-09-20  7:37         ` [dpdk-dev] [PATCH v5 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-09-27 10:36           ` Bruce Richardson [this message]
2019-09-27 14:14             ` Baran, MarcinX
2019-09-27 10:37           ` Bruce Richardson
2019-09-27 11:01           ` Bruce Richardson
2019-09-27 14:51             ` Baran, MarcinX
2019-09-27 15:00               ` Bruce Richardson
2019-09-27 15:16                 ` Baran, MarcinX
2019-09-27 13:22           ` Bruce Richardson
2019-09-27 15:13             ` Baran, MarcinX
2019-09-30  7:50         ` [dpdk-dev] [PATCH v6 0/6] examples/ioat: sample app on ioat driver usage Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 1/6] examples/ioat: create " Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 2/6] examples/ioat: add software copy support Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 3/6] examples/ioat: add rawdev copy mode support Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 4/6] examples/ioat: add two threads configuration Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 5/6] examples/ioat: add stats printing for each port Marcin Baran
2019-09-30  7:50           ` [dpdk-dev] [PATCH v6 6/6] doc/guides/: provide IOAT sample app guide Marcin Baran
2019-10-03  9:48           ` [dpdk-dev] [PATCH v6 0/6] examples/ioat: sample app on ioat driver usage Bruce Richardson
2019-10-04 17:16           ` Kevin Traynor
2019-10-07 11:10             ` Bruce Richardson
2019-10-07 11:08         ` [dpdk-dev] [PATCH v7 0/6] examples/ioat: sample app for ioat driver Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 1/6] examples/ioat: new " Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 2/6] examples/ioat: add software copy support Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 3/6] examples/ioat: add rawdev copy mode support Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 4/6] examples/ioat: add two threads configuration Bruce Richardson
2019-10-27 17:04             ` Thomas Monjalon
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 5/6] examples/ioat: add stats printing for each port Bruce Richardson
2019-10-07 11:08           ` [dpdk-dev] [PATCH v7 6/6] doc/guides/: provide IOAT sample app guide Bruce Richardson
2019-10-27 17:07             ` Thomas Monjalon
2019-10-27 17:07           ` [dpdk-dev] [PATCH v7 0/6] examples/ioat: sample app for ioat driver Thomas Monjalon

Reply instructions:

You may reply publically 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=20190927103625.GF1847@bricha3-MOBL.ger.corp.intel.com \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=marcinx.baran@intel.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

DPDK patches and discussions

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/ public-inbox