diff mbox series

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

Message ID 20210526074712.9270-2-hemant.agrawal@nxp.com (mailing list archive)
State Changes Requested, archived
Delegated to: Thomas Monjalon
Headers
Series [1/2] doc: add policy for adding vendor PMD specific examples |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-intel-Functional fail Functional Testing issues
ci/Intel-compilation success Compilation OK
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot success github build: passed
ci/intel-Testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-mellanox-Functional fail Functional Testing issues

Commit Message

Hemant Agrawal May 26, 2021, 7:47 a.m. UTC 
  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%)

Comments

Thomas Monjalon June 17, 2021, 7:17 a.m. UTC | #1 
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?
Jerin Jacob July 5, 2021, 8:49 a.m. UTC | #2 
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
>
Jerin Jacob July 5, 2021, 8:53 a.m. UTC | #3 
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.

>
>
Thomas Monjalon Nov. 17, 2021, 11:01 a.m. UTC | #4 
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?
Thomas Monjalon Nov. 17, 2021, 11:02 a.m. UTC | #5 
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/
diff mbox series

Patch

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',