| Message ID | 20210526074712.9270-1-hemant.agrawal@nxp.com |
|---|---|
| State | New |
| Headers | show |
| Series | [1/2] doc: add policy for adding vendor PMD specific examples | expand |
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 >
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.
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
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 >
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.
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>
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>
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.
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(-) -- 2.17.1