[v2 1/2] doc: add policy for adding vendor PMD specific examples
Hemant Agrawal
hemant.agrawal at nxp.com
Wed Jul 5 11:56:25 CEST 2023
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 at nxp.com>
Acked-by: Jerin Jacob <jerinj at 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
More information about the dev
mailing list