[dpdk-dev] [PATCH v4 10/10] doc: add application usage guide for l2fwd-event

[Jerin Jacob]

On Tue, Sep 24, 2019 at 3:13 PM <pbhagavatula at marvell.com> wrote:
>
> From: Sunil Kumar Kori <skori at marvell.com>
>
> Add documentation for l2fwd-event example.
> Update MAINTAINERS file claiming responsibility of l2fwd-event.
>
> Signed-off-by: Sunil Kumar Kori <skori at marvell.com>
> ---
>  MAINTAINERS                                   |   5 +
>  doc/guides/sample_app_ug/index.rst            |   1 +
>  doc/guides/sample_app_ug/intro.rst            |   5 +
>  .../l2_forward_event_real_virtual.rst         | 799 ++++++++++++++++++

Missing release notes update.

>  4 files changed, 810 insertions(+)
>  create mode 100644 doc/guides/sample_app_ug/l2_forward_event_real_virtual.rst
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index b3d9aaddd..d8e1fa84d 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1458,6 +1458,11 @@ M: Tomasz Kantecki <tomasz.kantecki at intel.com>
>  F: doc/guides/sample_app_ug/l2_forward_cat.rst
>  F: examples/l2fwd-cat/
>
> +M: Sunil Kumar Kori <skori at marvell.com>
> +M: Pavan Nikhilesh <pbhagavatula at marvell.com>
> +F: examples/l2fwd-event/

I think, you can add
T: git://dpdk.org/next/dpdk-next-eventdev

and move this section to first patch.


> +F: doc/guides/sample_app_ug/l2_forward_event_real_virtual.rst

I think, file name can be l2_forward_event.rst. looks like
"real_virtual" is legacy stuff.

> +
>  F: examples/l3fwd/
>  F: doc/guides/sample_app_ug/l3_forward.rst
>
> diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
> index f23f8f59e..83a4f8d5c 100644
> --- a/doc/guides/sample_app_ug/index.rst
> +++ b/doc/guides/sample_app_ug/index.rst
> @@ -26,6 +26,7 @@ Sample Applications User Guides
>      l2_forward_crypto
>      l2_forward_job_stats
>      l2_forward_real_virtual
> +    l2_forward_event_real_virtual

l2_forward_event

>      l2_forward_cat
>      l3_forward
>      l3_forward_power_man
> diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst
> index 90704194a..b33904ed1 100644
> --- a/doc/guides/sample_app_ug/intro.rst
> +++ b/doc/guides/sample_app_ug/intro.rst
> @@ -87,6 +87,11 @@ examples are highlighted below.
>    forwarding, or ``l2fwd`` application does forwarding based on Ethernet MAC
>    addresses like a simple switch.
>
> +* :doc:`Network Layer 2 forwarding<l2_forward_eventdev_real_virtual>`: The Network Layer 2
> +  forwarding, or ``l2fwd-event`` application does forwarding based on Ethernet MAC
> +  addresses like a simple switch. It demonstrate usage of poll and event mode Rx/Tx
> +  mechanism.
> +
>  * :doc:`Network Layer 3 forwarding<l3_forward>`: The Network Layer3
>    forwarding, or ``l3fwd`` application does forwarding based on Internet
>    Protocol, IPv4 or IPv6 like a simple router.
> diff --git a/doc/guides/sample_app_ug/l2_forward_event_real_virtual.rst b/doc/guides/sample_app_ug/l2_forward_event_real_virtual.rst
> new file mode 100644
> index 000000000..7cea8efaf
> --- /dev/null
> +++ b/doc/guides/sample_app_ug/l2_forward_event_real_virtual.rst
> @@ -0,0 +1,799 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2010-2014 Intel Corporation.
> +
> +.. _l2_fwd_event_app_real_and_virtual:
> +
> +L2 Forwarding Eventdev Sample Application (in Real and Virtualized Environments)
> +================================================================================
> +
> +The L2 Forwarding eventdev sample application is a simple example of packet
> +processing using the Data Plane Development Kit (DPDK) to demonstrate usage of
> +poll and event mode packet I/O mechanism which also takes advantage of Single
> +Root I/O Virtualization (SR-IOV) features in a virtualized environment.

The SR-IOV section can be omitted. it is from legacy.