[dpdk-dev] [PATCH 1/2] doc: add policy for adding vendor PMD specific examples

[dpdk-dev] [PATCH 1/2] doc: add policy for adding vendor PMD specific examples

[Hemant Agrawal]

This patch update the dpdk sample app policy to support
vendor PMD specific test examples in the respective drivers
sub-directory in examples.

Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/sample_app_ug/intro.rst | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst
index 8ff223b16c..fd34e7790d 100644
--- a/doc/guides/sample_app_ug/intro.rst
+++ b/doc/guides/sample_app_ug/intro.rst
@@ -58,10 +58,6 @@ examples are highlighted below.
   forwarding Graph, or ``l3fwd_graph`` application does forwarding based on IPv4
   like a simple router with DPDK Graph framework.
 
-* :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.
@@ -94,3 +90,15 @@ examples are highlighted below.
 There are many more examples shown in the following chapters. Each of the
 documented sample applications show how to compile, configure and run the
 application as well as explaining the main functionality of the code.
+
+Driver specific Sample Application
+----------------------------------
+
+There are case where exiting sample applications may not be suitable to test
+a new driver contribution. In such cases a new driver specific sample application
+can be added to specific drivers sub-directory in the examples folder with prior
+approval from DPDK technical board. e.g.
+
+* :doc:`Hardware packet copying<ioat>`: The Hardware packet copying,
+  or ``ioat`` application demonstrates how to use IOAT rawdev driver for
+  copying packets between two threads.
-- 
2.17.1

[dpdk-dev] [PATCH 2/2] examples: move vendor specific apps to drivers sub directory

[Hemant Agrawal]

As approved by DPDK technical board on 2021-03-24 NTB and IOAT
raw driver's example application will be moved to
example/drivers/raw/ to avoid PMD specific example application
to show up in examples directory.

Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/sample_app_ug/ioat.rst           | 2 +-
 doc/guides/sample_app_ug/ntb.rst            | 2 +-
 examples/{ => drivers/raw}/ioat/Makefile    | 0
 examples/{ => drivers/raw}/ioat/ioatfwd.c   | 0
 examples/{ => drivers/raw}/ioat/meson.build | 0
 examples/{ => drivers/raw}/ntb/Makefile     | 0
 examples/{ => drivers/raw}/ntb/meson.build  | 0
 examples/{ => drivers/raw}/ntb/ntb_fwd.c    | 0
 examples/meson.build                        | 4 ++--
 9 files changed, 4 insertions(+), 4 deletions(-)
 rename examples/{ => drivers/raw}/ioat/Makefile (100%)
 rename examples/{ => drivers/raw}/ioat/ioatfwd.c (100%)
 rename examples/{ => drivers/raw}/ioat/meson.build (100%)
 rename examples/{ => drivers/raw}/ntb/Makefile (100%)
 rename examples/{ => drivers/raw}/ntb/meson.build (100%)
 rename examples/{ => drivers/raw}/ntb/ntb_fwd.c (100%)

diff --git a/doc/guides/sample_app_ug/ioat.rst b/doc/guides/sample_app_ug/ioat.rst
index 7eb557f91c..72d5d17c07 100644
--- a/doc/guides/sample_app_ug/ioat.rst
+++ b/doc/guides/sample_app_ug/ioat.rst
@@ -29,7 +29,7 @@ Compiling the Application
 
 To compile the sample application see :doc:`compiling`.
 
-The application is located in the ``ioat`` sub-directory.
+The ``ioat`` application code is located in the ``drivers/raw`` sub-directory.
 
 
 Running the Application
diff --git a/doc/guides/sample_app_ug/ntb.rst b/doc/guides/sample_app_ug/ntb.rst
index f80b221db7..20e1f55a2f 100644
--- a/doc/guides/sample_app_ug/ntb.rst
+++ b/doc/guides/sample_app_ug/ntb.rst
@@ -22,7 +22,7 @@ Compiling the Application
 
 To compile the sample application see :doc:`compiling`.
 
-The application is located in the ``ntb`` sub-directory.
+The ``ntb`` application code is located in the ``drivers/raw`` sub-directory.
 
 Running the Application
 -----------------------
diff --git a/examples/ioat/Makefile b/examples/drivers/raw/ioat/Makefile
similarity index 100%
rename from examples/ioat/Makefile
rename to examples/drivers/raw/ioat/Makefile
diff --git a/examples/ioat/ioatfwd.c b/examples/drivers/raw/ioat/ioatfwd.c
similarity index 100%
rename from examples/ioat/ioatfwd.c
rename to examples/drivers/raw/ioat/ioatfwd.c
diff --git a/examples/ioat/meson.build b/examples/drivers/raw/ioat/meson.build
similarity index 100%
rename from examples/ioat/meson.build
rename to examples/drivers/raw/ioat/meson.build
diff --git a/examples/ntb/Makefile b/examples/drivers/raw/ntb/Makefile
similarity index 100%
rename from examples/ntb/Makefile
rename to examples/drivers/raw/ntb/Makefile
diff --git a/examples/ntb/meson.build b/examples/drivers/raw/ntb/meson.build
similarity index 100%
rename from examples/ntb/meson.build
rename to examples/drivers/raw/ntb/meson.build
diff --git a/examples/ntb/ntb_fwd.c b/examples/drivers/raw/ntb/ntb_fwd.c
similarity index 100%
rename from examples/ntb/ntb_fwd.c
rename to examples/drivers/raw/ntb/ntb_fwd.c
diff --git a/examples/meson.build b/examples/meson.build
index 07e682401b..e0664c09df 100644
--- a/examples/meson.build
+++ b/examples/meson.build
@@ -12,13 +12,14 @@ all_examples = [
         'bond',
         'cmdline',
         'distributor',
+        'drivers/raw/ioat',
+        'drivers/raw/ntb',
         'ethtool',
         'eventdev_pipeline',
         'fips_validation',
         'flow_classify',
         'flow_filtering',
         'helloworld',
-        'ioat',
         'ip_fragmentation',
         'ip_pipeline',
         'ip_reassembly',
@@ -41,7 +42,6 @@ all_examples = [
         'multi_process/hotplug_mp',
         'multi_process/simple_mp',
         'multi_process/symmetric_mp',
-        'ntb',
         'packet_ordering',
         'performance-thread/l3fwd-thread',
         'performance-thread/pthread_shim',
-- 
2.17.1

Re: [dpdk-dev] [PATCH 2/2] examples: move vendor specific apps to drivers sub directory

[Thomas Monjalon]

26/05/2021 09:47, Hemant Agrawal:
> As approved by DPDK technical board on 2021-03-24 NTB and IOAT
> raw driver's example application will be moved to
> example/drivers/raw/ to avoid PMD specific example application

examples with a s :)

> to show up in examples directory.
> 
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> ---
>  examples/{ => drivers/raw}/ioat/Makefile    | 0
>  examples/{ => drivers/raw}/ioat/ioatfwd.c   | 0
>  examples/{ => drivers/raw}/ioat/meson.build | 0
>  examples/{ => drivers/raw}/ntb/Makefile     | 0
>  examples/{ => drivers/raw}/ntb/meson.build  | 0
>  examples/{ => drivers/raw}/ntb/ntb_fwd.c    | 0

I'm afraid the name is confusing.
We could expect some driver example in such a path,
but it is just an use of the driver.

Any other idea of naming?

Re: [dpdk-dev] [PATCH 2/2] examples: move vendor specific apps to drivers sub directory

[Jerin Jacob]

On Thu, Jun 17, 2021 at 12:47 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> 26/05/2021 09:47, Hemant Agrawal:
> > As approved by DPDK technical board on 2021-03-24 NTB and IOAT
> > raw driver's example application will be moved to
> > example/drivers/raw/ to avoid PMD specific example application
>
> examples with a s :)
>
> > to show up in examples directory.
> >
> > Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> > ---
> >  examples/{ => drivers/raw}/ioat/Makefile    | 0
> >  examples/{ => drivers/raw}/ioat/ioatfwd.c   | 0
> >  examples/{ => drivers/raw}/ioat/meson.build | 0
> >  examples/{ => drivers/raw}/ntb/Makefile     | 0
> >  examples/{ => drivers/raw}/ntb/meson.build  | 0
> >  examples/{ => drivers/raw}/ntb/ntb_fwd.c    | 0
>
> I'm afraid the name is confusing.
> We could expect some driver example in such a path,
> but it is just an use of the driver.
>
> Any other idea of naming?

Like Linux kernel, Skelton drivers can be added in drivers/ itself, like
the one existing (drivers/event/skeleton/).

If there are no better suggestions,  examples/drivers/raw/.. looks good to me.

>
>

Re: [dpdk-dev] [PATCH 2/2] examples: move vendor specific apps to drivers sub directory

[Thomas Monjalon]

05/07/2021 10:53, Jerin Jacob:
> On Thu, Jun 17, 2021 at 12:47 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > 26/05/2021 09:47, Hemant Agrawal:
> > > As approved by DPDK technical board on 2021-03-24 NTB and IOAT
> > > raw driver's example application will be moved to
> > > example/drivers/raw/ to avoid PMD specific example application
> >
> > examples with a s :)
> >
> > > to show up in examples directory.
> > >
> > > Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> > > ---
> > >  examples/{ => drivers/raw}/ioat/Makefile    | 0
> > >  examples/{ => drivers/raw}/ioat/ioatfwd.c   | 0
> > >  examples/{ => drivers/raw}/ioat/meson.build | 0
> > >  examples/{ => drivers/raw}/ntb/Makefile     | 0
> > >  examples/{ => drivers/raw}/ntb/meson.build  | 0
> > >  examples/{ => drivers/raw}/ntb/ntb_fwd.c    | 0
> >
> > I'm afraid the name is confusing.
> > We could expect some driver example in such a path,
> > but it is just an use of the driver.
> >
> > Any other idea of naming?
> 
> Like Linux kernel, Skelton drivers can be added in drivers/ itself, like
> the one existing (drivers/event/skeleton/).
> 
> If there are no better suggestions,  examples/drivers/raw/.. looks good to me.

It could have been examples/rawdev/ntb/

Re: [dpdk-dev] [PATCH 2/2] examples: move vendor specific apps to drivers sub directory

[Jerin Jacob]

On Wed, May 26, 2021 at 1:19 PM Hemant Agrawal <hemant.agrawal@nxp.com> wrote:
>
> As approved by DPDK technical board on 2021-03-24 NTB and IOAT

You could add a link to the MoM of the TB meeting.

> raw driver's example application will be moved to
> example/drivers/raw/ to avoid PMD specific example application
> to show up in examples directory.
>
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> ---
>  doc/guides/sample_app_ug/ioat.rst           | 2 +-
>  doc/guides/sample_app_ug/ntb.rst            | 2 +-
>  examples/{ => drivers/raw}/ioat/Makefile    | 0
>  examples/{ => drivers/raw}/ioat/ioatfwd.c   | 0
>  examples/{ => drivers/raw}/ioat/meson.build | 0
>  examples/{ => drivers/raw}/ntb/Makefile     | 0
>  examples/{ => drivers/raw}/ntb/meson.build  | 0
>  examples/{ => drivers/raw}/ntb/ntb_fwd.c    | 0
>  examples/meson.build                        | 4 ++--
>  9 files changed, 4 insertions(+), 4 deletions(-)
>  rename examples/{ => drivers/raw}/ioat/Makefile (100%)
>  rename examples/{ => drivers/raw}/ioat/ioatfwd.c (100%)
>  rename examples/{ => drivers/raw}/ioat/meson.build (100%)
>  rename examples/{ => drivers/raw}/ntb/Makefile (100%)
>  rename examples/{ => drivers/raw}/ntb/meson.build (100%)
>  rename examples/{ => drivers/raw}/ntb/ntb_fwd.c (100%)
>
> diff --git a/doc/guides/sample_app_ug/ioat.rst b/doc/guides/sample_app_ug/ioat.rst
> index 7eb557f91c..72d5d17c07 100644
> --- a/doc/guides/sample_app_ug/ioat.rst
> +++ b/doc/guides/sample_app_ug/ioat.rst
> @@ -29,7 +29,7 @@ Compiling the Application
>
>  To compile the sample application see :doc:`compiling`.
>
> -The application is located in the ``ioat`` sub-directory.
> +The ``ioat`` application code is located in the ``drivers/raw`` sub-directory.
>
>
>  Running the Application
> diff --git a/doc/guides/sample_app_ug/ntb.rst b/doc/guides/sample_app_ug/ntb.rst
> index f80b221db7..20e1f55a2f 100644
> --- a/doc/guides/sample_app_ug/ntb.rst
> +++ b/doc/guides/sample_app_ug/ntb.rst
> @@ -22,7 +22,7 @@ Compiling the Application
>
>  To compile the sample application see :doc:`compiling`.
>
> -The application is located in the ``ntb`` sub-directory.
> +The ``ntb`` application code is located in the ``drivers/raw`` sub-directory.
>
>  Running the Application
>  -----------------------
> diff --git a/examples/ioat/Makefile b/examples/drivers/raw/ioat/Makefile
> similarity index 100%
> rename from examples/ioat/Makefile
> rename to examples/drivers/raw/ioat/Makefile
> diff --git a/examples/ioat/ioatfwd.c b/examples/drivers/raw/ioat/ioatfwd.c
> similarity index 100%
> rename from examples/ioat/ioatfwd.c
> rename to examples/drivers/raw/ioat/ioatfwd.c
> diff --git a/examples/ioat/meson.build b/examples/drivers/raw/ioat/meson.build
> similarity index 100%
> rename from examples/ioat/meson.build
> rename to examples/drivers/raw/ioat/meson.build
> diff --git a/examples/ntb/Makefile b/examples/drivers/raw/ntb/Makefile
> similarity index 100%
> rename from examples/ntb/Makefile
> rename to examples/drivers/raw/ntb/Makefile
> diff --git a/examples/ntb/meson.build b/examples/drivers/raw/ntb/meson.build
> similarity index 100%
> rename from examples/ntb/meson.build
> rename to examples/drivers/raw/ntb/meson.build
> diff --git a/examples/ntb/ntb_fwd.c b/examples/drivers/raw/ntb/ntb_fwd.c
> similarity index 100%
> rename from examples/ntb/ntb_fwd.c
> rename to examples/drivers/raw/ntb/ntb_fwd.c
> diff --git a/examples/meson.build b/examples/meson.build
> index 07e682401b..e0664c09df 100644
> --- a/examples/meson.build
> +++ b/examples/meson.build
> @@ -12,13 +12,14 @@ all_examples = [
>          'bond',
>          'cmdline',
>          'distributor',
> +        'drivers/raw/ioat',
> +        'drivers/raw/ntb',
>          'ethtool',
>          'eventdev_pipeline',
>          'fips_validation',
>          'flow_classify',
>          'flow_filtering',
>          'helloworld',
> -        'ioat',
>          'ip_fragmentation',
>          'ip_pipeline',
>          'ip_reassembly',
> @@ -41,7 +42,6 @@ all_examples = [
>          'multi_process/hotplug_mp',
>          'multi_process/simple_mp',
>          'multi_process/symmetric_mp',
> -        'ntb',
>          'packet_ordering',
>          'performance-thread/l3fwd-thread',
>          'performance-thread/pthread_shim',
> --
> 2.17.1
>

Re: [dpdk-dev] [PATCH 2/2] examples: move vendor specific apps to drivers sub directory

[Thomas Monjalon]

26/05/2021 09:47, Hemant Agrawal:
> As approved by DPDK technical board on 2021-03-24 NTB and IOAT
> raw driver's example application will be moved to
> example/drivers/raw/ to avoid PMD specific example application
> to show up in examples directory.
> 
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> ---
>  doc/guides/sample_app_ug/ioat.rst           | 2 +-
>  doc/guides/sample_app_ug/ntb.rst            | 2 +-
>  examples/{ => drivers/raw}/ioat/Makefile    | 0
>  examples/{ => drivers/raw}/ioat/ioatfwd.c   | 0
>  examples/{ => drivers/raw}/ioat/meson.build | 0
>  examples/{ => drivers/raw}/ntb/Makefile     | 0
>  examples/{ => drivers/raw}/ntb/meson.build  | 0
>  examples/{ => drivers/raw}/ntb/ntb_fwd.c    | 0
>  examples/meson.build                        | 4 ++--

ioat example became dma generic example.
So only ntb remains.
Is it still relevant?

Re: [dpdk-dev] [PATCH 1/2] doc: add policy for adding vendor PMD specific examples

[Jerin Jacob]

On Wed, May 26, 2021 at 1:19 PM Hemant Agrawal <hemant.agrawal@nxp.com> wrote:
>
> This patch update the dpdk sample app policy to support
> vendor PMD specific test examples in the respective drivers
> sub-directory in examples.
>
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> ---
>  doc/guides/sample_app_ug/intro.rst | 16 ++++++++++++----
>  1 file changed, 12 insertions(+), 4 deletions(-)
>
> diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst
> index 8ff223b16c..fd34e7790d 100644
> --- a/doc/guides/sample_app_ug/intro.rst
> +++ b/doc/guides/sample_app_ug/intro.rst
> @@ -58,10 +58,6 @@ examples are highlighted below.
>    forwarding Graph, or ``l3fwd_graph`` application does forwarding based on IPv4
>    like a simple router with DPDK Graph framework.
>
> -* :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.
> @@ -94,3 +90,15 @@ examples are highlighted below.
>  There are many more examples shown in the following chapters. Each of the
>  documented sample applications show how to compile, configure and run the
>  application as well as explaining the main functionality of the code.
> +
> +Driver specific Sample Application
> +----------------------------------
> +
> +There are case where exiting sample applications may not be suitable to test

cases

> +a new driver contribution. In such cases a new driver specific sample application
> +can be added to specific drivers sub-directory in the examples folder with prior
> +approval from DPDK technical board. e.g.
> +
> +* :doc:`Hardware packet copying<ioat>`: The Hardware packet copying,
> +  or ``ioat`` application demonstrates how to use IOAT rawdev driver for
> +  copying packets between two threads.

With the above fix, it looks good to me.

Acked-by: Jerin Jacob <jerinj@marvell.com>


> --
> 2.17.1
>

Re: [dpdk-dev] [PATCH 1/2] doc: add policy for adding vendor PMD specific examples

[Thomas Monjalon]

26/05/2021 09:47, Hemant Agrawal:
> This patch update the dpdk sample app policy to support
> vendor PMD specific test examples in the respective drivers
> sub-directory in examples.

Please could you add a link to the decision in techboard minutes?

> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> ---
>  doc/guides/sample_app_ug/intro.rst | 16 ++++++++++++----
>  1 file changed, 12 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst
> index 8ff223b16c..fd34e7790d 100644
> --- a/doc/guides/sample_app_ug/intro.rst
> +++ b/doc/guides/sample_app_ug/intro.rst
> @@ -58,10 +58,6 @@ examples are highlighted below.
>    forwarding Graph, or ``l3fwd_graph`` application does forwarding based on IPv4
>    like a simple router with DPDK Graph framework.
>  
> -* :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.
> @@ -94,3 +90,15 @@ examples are highlighted below.
>  There are many more examples shown in the following chapters. Each of the
>  documented sample applications show how to compile, configure and run the
>  application as well as explaining the main functionality of the code.
> +
> +Driver specific Sample Application
> +----------------------------------
> +
> +There are case where exiting sample applications may not be suitable to test

typo: existing

> +a new driver contribution. In such cases a new driver specific sample application
> +can be added to specific drivers sub-directory in the examples folder with prior
> +approval from DPDK technical board. e.g.
> +
> +* :doc:`Hardware packet copying<ioat>`: The Hardware packet copying,
> +  or ``ioat`` application demonstrates how to use IOAT rawdev driver for
> +  copying packets between two threads.

This example is now generic and renamed as examples/dma.

Re: [dpdk-dev] [PATCH 1/2] doc: add policy for adding vendor PMD specific examples

[Stephen Hemminger]

On Wed, 17 Nov 2021 11:57:34 +0100
Thomas Monjalon <thomas@monjalon.net> wrote:

> 26/05/2021 09:47, Hemant Agrawal:
> > This patch update the dpdk sample app policy to support
> > vendor PMD specific test examples in the respective drivers
> > sub-directory in examples.  
> 
> Please could you add a link to the decision in techboard minutes?
> 
> > Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> > ---
> >  doc/guides/sample_app_ug/intro.rst | 16 ++++++++++++----
> >  1 file changed, 12 insertions(+), 4 deletions(-)
> > 
> > diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst
> > index 8ff223b16c..fd34e7790d 100644
> > --- a/doc/guides/sample_app_ug/intro.rst
> > +++ b/doc/guides/sample_app_ug/intro.rst
> > @@ -58,10 +58,6 @@ examples are highlighted below.
> >    forwarding Graph, or ``l3fwd_graph`` application does forwarding based on IPv4
> >    like a simple router with DPDK Graph framework.
> >  
> > -* :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.
> > @@ -94,3 +90,15 @@ examples are highlighted below.
> >  There are many more examples shown in the following chapters. Each of the
> >  documented sample applications show how to compile, configure and run the
> >  application as well as explaining the main functionality of the code.
> > +
> > +Driver specific Sample Application
> > +----------------------------------
> > +
> > +There are case where exiting sample applications may not be suitable to test  
> 
> typo: existing
> 
> > +a new driver contribution. In such cases a new driver specific sample application
> > +can be added to specific drivers sub-directory in the examples folder with prior
> > +approval from DPDK technical board. e.g.
> > +
> > +* :doc:`Hardware packet copying<ioat>`: The Hardware packet copying,
> > +  or ``ioat`` application demonstrates how to use IOAT rawdev driver for
> > +  copying packets between two threads.  
> 
> This example is now generic and renamed as examples/dma.
> 
> 

This patch never got an update.
Please resubmit, would be good to get renames in by 23.11 release

[v2 1/2] doc: add policy for adding vendor PMD specific examples

[Hemant Agrawal]

This patch update the dpdk sample app policy to support
vendor PMD specific test examples in the respective drivers
sub-directory in examples.

Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Jerin Jacob <jerinj@marvell.com>
---
 doc/guides/sample_app_ug/intro.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst
index e765f1fd6b..279aecdfda 100644
--- a/doc/guides/sample_app_ug/intro.rst
+++ b/doc/guides/sample_app_ug/intro.rst
@@ -94,3 +94,15 @@ examples are highlighted below.
 There are many more examples shown in the following chapters. Each of the
 documented sample applications show how to compile, configure and run the
 application as well as explaining the main functionality of the code.
+
+Driver specific Sample Application
+----------------------------------
+
+There are cases where existing sample applications may not be suitable to test
+a new driver contribution. In such cases a new driver specific sample application
+can be added to specific drivers sub-directory in the examples folder with prior
+approval from DPDK technical board. e.g.
+
+* :doc:`NTB Sample Application<ntb>`: The NTB Sample Application,
+  or ``ntb`` application demonstrates how to use NTB rawdev driver for
+  packet based processing between two systems..
-- 
2.17.1

[v2 2/2] examples: move vendor specific apps to drivers sub directory

[Hemant Agrawal]

As approved by DPDK technical board on 2021-03-24 NTB
raw driver example application will be moved to
example/rawdev/ to avoid PMD specific example application
to show up in examples directory.

Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/sample_app_ug/ntb.rst      |  2 +-
 examples/meson.build                  |  2 +-
 examples/rawdev/Makefile              | 10 ++++++++++
 examples/{ => rawdev}/ntb/Makefile    |  0
 examples/{ => rawdev}/ntb/meson.build |  0
 examples/{ => rawdev}/ntb/ntb_fwd.c   |  0
 6 files changed, 12 insertions(+), 2 deletions(-)
 create mode 100644 examples/rawdev/Makefile
 rename examples/{ => rawdev}/ntb/Makefile (100%)
 rename examples/{ => rawdev}/ntb/meson.build (100%)
 rename examples/{ => rawdev}/ntb/ntb_fwd.c (100%)

diff --git a/doc/guides/sample_app_ug/ntb.rst b/doc/guides/sample_app_ug/ntb.rst
index f80b221db7..10f7395aff 100644
--- a/doc/guides/sample_app_ug/ntb.rst
+++ b/doc/guides/sample_app_ug/ntb.rst
@@ -22,7 +22,7 @@ Compiling the Application
 
 To compile the sample application see :doc:`compiling`.
 
-The application is located in the ``ntb`` sub-directory.
+The ``ntb`` application code is located in the ``rawdev/ntb`` sub-directory.
 
 Running the Application
 -----------------------
diff --git a/examples/meson.build b/examples/meson.build
index 55ba8847a0..f4a1ea3f70 100644
--- a/examples/meson.build
+++ b/examples/meson.build
@@ -39,12 +39,12 @@ all_examples = [
         'multi_process/hotplug_mp',
         'multi_process/simple_mp',
         'multi_process/symmetric_mp',
-        'ntb',
         'packet_ordering',
         'pipeline',
         'ptpclient',
         'qos_meter',
         'qos_sched',
+        'rawdev/ntb',
         'rxtx_callbacks',
         'server_node_efd/efd_node',
         'server_node_efd/efd_server',
diff --git a/examples/rawdev/Makefile b/examples/rawdev/Makefile
new file mode 100644
index 0000000000..0c26937a13
--- /dev/null
+++ b/examples/rawdev/Makefile
@@ -0,0 +1,10 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2023 NXP
+
+subdirs := ntb
+
+.PHONY: all static shared clean $(subdirs)
+all static shared clean: $(subdirs)
+
+$(subdirs):
+	$(MAKE) -C $@ $(MAKECMDGOALS)
diff --git a/examples/ntb/Makefile b/examples/rawdev/ntb/Makefile
similarity index 100%
rename from examples/ntb/Makefile
rename to examples/rawdev/ntb/Makefile
diff --git a/examples/ntb/meson.build b/examples/rawdev/ntb/meson.build
similarity index 100%
rename from examples/ntb/meson.build
rename to examples/rawdev/ntb/meson.build
diff --git a/examples/ntb/ntb_fwd.c b/examples/rawdev/ntb/ntb_fwd.c
similarity index 100%
rename from examples/ntb/ntb_fwd.c
rename to examples/rawdev/ntb/ntb_fwd.c
-- 
2.17.1

Re: [v2 2/2] examples: move vendor specific apps to drivers sub directory

[Stephen Hemminger]

On Wed,  5 Jul 2023 15:26:26 +0530
Hemant Agrawal <hemant.agrawal@nxp.com> wrote:

> As approved by DPDK technical board on 2021-03-24 NTB
> raw driver example application will be moved to
> example/rawdev/ to avoid PMD specific example application
> to show up in examples directory.
> 
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>

Acked-by: Stephen Hemminger <stephen@networkplumber.org>

Re: [v2 1/2] doc: add policy for adding vendor PMD specific examples

[Jerin Jacob]

On Wed, Jul 5, 2023 at 3:26 PM Hemant Agrawal <hemant.agrawal@nxp.com> wrote:
>
> This patch update the dpdk sample app policy to support
> vendor PMD specific test examples in the respective drivers
> sub-directory in examples.
>
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> Acked-by: Jerin Jacob <jerinj@marvell.com>
> ---
>  doc/guides/sample_app_ug/intro.rst | 12 ++++++++++++


Policy docs are getting added to contributors section. Please move to that area.
Example: http://patches.dpdk.org/project/dpdk/patch/20230518132139.1350234-1-jerinj@marvell.com/


>  1 file changed, 12 insertions(+)
>
> diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst
> index e765f1fd6b..279aecdfda 100644
> --- a/doc/guides/sample_app_ug/intro.rst
> +++ b/doc/guides/sample_app_ug/intro.rst
> @@ -94,3 +94,15 @@ examples are highlighted below.
>  There are many more examples shown in the following chapters. Each of the
>  documented sample applications show how to compile, configure and run the
>  application as well as explaining the main functionality of the code.
> +
> +Driver specific Sample Application
> +----------------------------------
> +
> +There are cases where existing sample applications may not be suitable to test
> +a new driver contribution. In such cases a new driver specific sample application
> +can be added to specific drivers sub-directory in the examples folder with prior
> +approval from DPDK technical board. e.g.
> +
> +* :doc:`NTB Sample Application<ntb>`: The NTB Sample Application,
> +  or ``ntb`` application demonstrates how to use NTB rawdev driver for
> +  packet based processing between two systems..
> --
> 2.17.1
>

Re: [v2 1/2] doc: add policy for adding vendor PMD specific examples

[Stephen Hemminger]

On Thu, 6 Jul 2023 10:30:14 +0530
Jerin Jacob <jerinjacobk@gmail.com> wrote:

> From: Jerin Jacob <jerinjacobk@gmail.com>
> To: Hemant Agrawal <hemant.agrawal@nxp.com>
> Cc: thomas@monjalon.net, dev@dpdk.org, stephen@networkplumber.org
> Subject: Re: [v2 1/2] doc: add policy for adding vendor PMD specific examples
> Date: Thu, 6 Jul 2023 10:30:14 +0530
> 
> On Wed, Jul 5, 2023 at 3:26 PM Hemant Agrawal <hemant.agrawal@nxp.com> wrote:
> >
> > This patch update the dpdk sample app policy to support
> > vendor PMD specific test examples in the respective drivers
> > sub-directory in examples.
> >
> > Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> > Acked-by: Jerin Jacob <jerinj@marvell.com>
> > ---
> >  doc/guides/sample_app_ug/intro.rst | 12 ++++++++++++  
> 
> 
> Policy docs are getting added to contributors section. Please move to that area.
> Example: http://patches.dpdk.org/project/dpdk/patch/20230518132139.1350234-1-jerinj@marvell.com/

This particular patch is not so much about policy for future devices.
Instead, it looks like help for the user to tell them that not all examples will
work on their hardware.

Re: [v2 1/2] doc: add policy for adding vendor PMD specific examples

[Stephen Hemminger]

On Wed,  5 Jul 2023 15:26:25 +0530
Hemant Agrawal <hemant.agrawal@nxp.com> wrote:

> This patch update the dpdk sample app policy to support
> vendor PMD specific test examples in the respective drivers
> sub-directory in examples.
> 
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> Acked-by: Jerin Jacob <jerinj@marvell.com>

Acked-by: Stephen Hemminger <stephen@networkplumber.org>