DPDK patches and discussions
 help / color / mirror / Atom feed
From: Hemant Agrawal <hemant.agrawal@nxp.com>
To: dev@dpdk.org
Cc: xiaoyun.li@intel.com, bruce.richardson@intel.com,
	jingjing.wu@intel.com, Hemant Agrawal <hemant.agrawal@nxp.com>
Subject: [dpdk-dev] [PATCH 1/2] doc: add policy for adding vendor PMD specific examples
Date: Wed, 26 May 2021 13:17:11 +0530	[thread overview]
Message-ID: <20210526074712.9270-1-hemant.agrawal@nxp.com> (raw)

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


             reply	other threads:[~2021-05-26  7:49 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-26  7:47 Hemant Agrawal [this message]
2021-05-26  7:47 ` [dpdk-dev] [PATCH 2/2] examples: move vendor specific apps to drivers sub directory Hemant Agrawal
2021-06-17  7:17   ` Thomas Monjalon
2021-07-05  8:53     ` Jerin Jacob
2021-11-17 11:02       ` Thomas Monjalon
2021-07-05  8:49   ` Jerin Jacob
2021-11-17 11:01   ` Thomas Monjalon
2021-07-05  8:47 ` [dpdk-dev] [PATCH 1/2] doc: add policy for adding vendor PMD specific examples Jerin Jacob
2021-11-17 10:57 ` Thomas Monjalon
2023-07-03 23:30   ` Stephen Hemminger
2023-07-05  9:56 ` [v2 " Hemant Agrawal
2023-07-05  9:56   ` [v2 2/2] examples: move vendor specific apps to drivers sub directory Hemant Agrawal
2023-07-06  5:00   ` [v2 1/2] doc: add policy for adding vendor PMD specific examples Jerin Jacob
2023-10-31 20:02     ` Stephen Hemminger

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210526074712.9270-1-hemant.agrawal@nxp.com \
    --to=hemant.agrawal@nxp.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=jingjing.wu@intel.com \
    --cc=xiaoyun.li@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).