From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 0A635A0546; Wed, 26 May 2021 09:49:15 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EA9AC4067C; Wed, 26 May 2021 09:49:14 +0200 (CEST) Received: from EUR01-VE1-obe.outbound.protection.outlook.com (mail-eopbgr140075.outbound.protection.outlook.com [40.107.14.75]) by mails.dpdk.org (Postfix) with ESMTP id 7E7264003F for ; Wed, 26 May 2021 09:49:13 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=ia5qojwc+ckHEMjHusEVWvcdED8a0q0p8ljWLh8xp3EzNIkFucnZcst0WOVfRne2/APz4XMlHJfCgV4EldFwhTnExUjSNDAowiGwoOOmGIz8TSRUO1vXfndKaYm04HLNQAmXMZAlW5hnOAvnwza9/AYaLippwEGr9XkwUZWaeCiIvnAhx8t7nY+ow+z96yha1YHU+FQkaywpxukJvqo/hmpIYrxpeqTaN8CHdXrEnrh6tekXEu91ys50jzZ8JW9iSpe3sgdAlGWIhk/eoGZK67fj6tyY1kVxs57GT598UP/ZtD+CtevFbdyuTEFyIyfNSX0AO0MMQnoJ8R8fQjf2wg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=fuhBd4d++yoMZtFQf4UTh1Dg7D0cCuJ8xk0I0B772RQ=; b=iGeX9f2HZB4TPqaKRNdqeZHJExMf/BjU2EYWMxpTeNGvl+MgihaCtXcYzyGXSOKbA4BJcrkChGq8hR6KZ/+aS/Wto3v5lNOV0ns10mbKwwR2OAj028X0ZbgEXHapZr6Imw6h9xtdwVYiN1McQDSwc+yTL+gqjpepkf3yEIHkAnBvLcHgJ3XVdav4I/43k2c1svpihQyF2+05Sz1GvdZvTBdFcbyhPHOaoh0W6E272KSWsnUpdiEgbwQs2pzDOX7NL6vaqLUwOCvoK00YVAb/eHL1gowMrctSwYk9EUrEgZY3AXQ3SQthU9eWMCnLz+0LpJvs7aa5q+Lbhehx6828Ag== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=nxp.com; dmarc=pass action=none header.from=nxp.com; dkim=pass header.d=nxp.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=fuhBd4d++yoMZtFQf4UTh1Dg7D0cCuJ8xk0I0B772RQ=; b=kMJ7IwXXDPbYF8z2HNbyZ7fAfaPDEBmut2LnJKi2lgTsAkUM2zpVvqHQJ/TNfcokITet2N6XoVoHm6G7juscLnCPQbpOAkY8JzRFO04mByH84uolgV6uK+wrflsWoha8kTBa7ZKvC7jz6exB3/vdCay25PFnIcIHoLUOjRGRPho= Authentication-Results: dpdk.org; dkim=none (message not signed) header.d=none;dpdk.org; dmarc=none action=none header.from=nxp.com; Received: from PAXPR04MB8173.eurprd04.prod.outlook.com (2603:10a6:102:1ca::20) by PR3PR04MB7306.eurprd04.prod.outlook.com (2603:10a6:102:81::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4173.20; Wed, 26 May 2021 07:49:12 +0000 Received: from PAXPR04MB8173.eurprd04.prod.outlook.com ([fe80::b9fa:7c06:b620:fbf2]) by PAXPR04MB8173.eurprd04.prod.outlook.com ([fe80::b9fa:7c06:b620:fbf2%7]) with mapi id 15.20.4150.027; Wed, 26 May 2021 07:49:12 +0000 From: Hemant Agrawal To: dev@dpdk.org Cc: xiaoyun.li@intel.com, bruce.richardson@intel.com, jingjing.wu@intel.com, Hemant Agrawal Date: Wed, 26 May 2021 13:17:11 +0530 Message-Id: <20210526074712.9270-1-hemant.agrawal@nxp.com> X-Mailer: git-send-email 2.17.1 Content-Type: text/plain X-Originating-IP: [92.120.0.67] X-ClientProxiedBy: SG2PR01CA0099.apcprd01.prod.exchangelabs.com (2603:1096:3:15::25) To PAXPR04MB8173.eurprd04.prod.outlook.com (2603:10a6:102:1ca::20) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from dpdk-xeon.ap.freescale.net (92.120.0.67) by SG2PR01CA0099.apcprd01.prod.exchangelabs.com (2603:1096:3:15::25) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4173.20 via Frontend Transport; Wed, 26 May 2021 07:49:10 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: ea97b3f5-9cc3-4d0b-8f27-08d9201ac0bf X-MS-TrafficTypeDiagnostic: PR3PR04MB7306: X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:8882; X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: BQhAs3tMp4wYmioLnuuUUSfyjhh4UgcHrleLOJpG8MH2CBIvTFm9JztjcrFgY2fGkW6N0KlXWw7tkWPTTyhZ1fn20Xd2UC+SOZOSul1PyXzWfMRp2a0kxsCvaSztHoqwJMcGytiGuR2N+zpbi2uD01r+ZlIyyOxHKyGZw+CxqGnVq/lVRjv+BHfzeIkccr5bb7iXt64ksrPcRpP0jancJ+T1xoHQgYubQKYWb3B4lbUee74LOkxfbYW3RN6eLMMWGBsWMp5S0rlU62ySNrOlBSdEFsbq6+T46NN8WZr2GlWt0H32F1uJ45ytRDNteGJUlK7XFb3Vd+NFCybEhIIw2cQSyvl2XN3QD1l2myjJ8nUqkBLAC3fJCmLzdRwaqSDaSMBASMUoEeZqYcSZEWRXCBdCv5aoiUtvbbYo4Swlqr5d6w1U2PhQMY6euaMiRIqSdOkU0G9S6MHCo/wX0+hyFh73L9j3dBN7ST1N/2j/NvZurmQqLVUvwwRj8gs72Gka/voBtOIeOtis8NyRBzGXBIbMkCxPQ40ZMkm8oLVSo+NLpU3T492JS2B5O3wsj7TuDWHVRMGacEpsjf/3GPyTEZl6tYSvDMwB05XntffsyBpWg+8UiW3Ek43eZcivMNywNqqNkvBH6Jyc+UBe9AmswRRdMudNfnzhqa7K/iQPvnc= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PAXPR04MB8173.eurprd04.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(396003)(376002)(39860400002)(366004)(136003)(346002)(36756003)(26005)(38350700002)(2616005)(66476007)(66946007)(66556008)(2906002)(316002)(186003)(16526019)(4326008)(956004)(44832011)(8936002)(6486002)(38100700002)(8676002)(83380400001)(478600001)(6506007)(86362001)(6916009)(1076003)(52116002)(6512007)(5660300002)(66574015); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData: =?us-ascii?Q?40NpFv0Yb3fdfCNDlAc5X1I4kAyCGgkXYIJp9uGJYYX+GAZlyLt+8il7rna9?= =?us-ascii?Q?T3r5vFvBdJfpxpnpD9LYVDlVCtSN5LUIWH2LEVZUI+LSrkIMeq6W6dWG8k6R?= =?us-ascii?Q?3zBX+fvdCSTMYRRAKm3+g7f4TC4tioHVsa4pXdmLuwNfNl6hgeKmhCaNY26j?= =?us-ascii?Q?xQKBzIZOon2cbaKzVFVAbPdg6nSsG/Wsqnw1cFExcr8AG97y25O1NsHE9nae?= =?us-ascii?Q?gv1g1+SdhrGEWBlpf4BzCdINvztURGuBXzi7WwrUCBoz6Sa3fha3Uj+uKpmb?= =?us-ascii?Q?Ol1urcOB00QUTD1JTv8LVoIe4ZDbXv0K6trrT/GqdEuP9xH4Pw1dlGLvUp0m?= =?us-ascii?Q?GXHD1xfO8f9PkcLfStPcFYpMny0An+c8ZZWTAJRG49Y36DdEDuzfaV/CfGt9?= =?us-ascii?Q?7GBOE0esoZnvPWt/ptBof5zxVTq8t/8Gd652DCwivyqeklLDL9ptAlE+aPX8?= =?us-ascii?Q?kTitOiABlOJnGxPh+KzolCMw5fN0zHVjfVsh89ipmQ09PEFQdsnUWb0Z0hSE?= =?us-ascii?Q?sEJx5rCOYphf2jy4oFKu9ekSa47HU2Y4kc15/RyY1LuBttqtH67i3YrjHzZW?= =?us-ascii?Q?bh4uU+MIDFUa4mVVdEU/lh0gLd72WCHKm/gmOaK8G/HAttQlZssZblOTeKoU?= =?us-ascii?Q?E2NV6u8eUmoMuBsSR/ZOZqleBmhqJALZKLc8e410CGadAR5bNsAqRn1CVN5D?= =?us-ascii?Q?O7iFw5K5JmUoYg2a1Wu8w3OtnwFYVOJ9J4XS1EzvYorpJsUSCyDdgGDufYo3?= =?us-ascii?Q?jMBm3tQ3wl50gd25wUjQgyXAwDL5+osptB+WoLgrzbWoEPMH1lYk6xZe2JKI?= =?us-ascii?Q?rln2fDt/Ss45ilPzXCnwj/PSCnRxBMsSZmwS9oguOMSuV0PLswdYUErM+E1/?= =?us-ascii?Q?IYRdGEEyAtMBv4C0Ld+0hvjLxN5er2KC58R4FBij+kQEOtdPLr5FF8DYBEHm?= =?us-ascii?Q?matan4uJ2toUZrvq7UQFIEUkHlvsF6IauPuxrJWbBMOVhxeSF0Od0S3E15Uk?= =?us-ascii?Q?wm1k4O7tZS6Vc2fT+VUEJuc4l+uMNbuIBPMeuMokhnhnFqPs24vVmE6AJXoN?= =?us-ascii?Q?nmVTeBhtEKHOrTmbX8f+L1phdL2dcT0OJYGoSo8Ml9wc14dMrTxMgkIPyiwb?= =?us-ascii?Q?jADMo2g30Q8ODA/ojLt+UpAg8dZ1KafrFqDFDNo14iA5Lqtbsx8zLCCl2JMl?= =?us-ascii?Q?Zf7LzELlPeA6AouTyPK3AHd1ql4oj9hj2POtkOPtpRVqfCW+iUZ/l6GQm6fJ?= =?us-ascii?Q?YoYud/63pb9JpnKTyQOJfFIlK3ozatEabcKqmovfGhh8LyMraAcRsMKni2U8?= =?us-ascii?Q?RvivaEPeo2ji5dhSDWwFe/Zz?= X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: ea97b3f5-9cc3-4d0b-8f27-08d9201ac0bf X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB8173.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 26 May 2021 07:49:12.6804 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: MQVxulFDhZytZYMBbHmheUr1m8upUlzN3uNMUU5/ktH155LZvOLmvxYWGNcBkQmE0mxYNIUpk6rAiFgsyxNMAg== X-MS-Exchange-Transport-CrossTenantHeadersStamped: PR3PR04MB7306 Subject: [dpdk-dev] [PATCH 1/2] doc: add policy for adding vendor PMD specific examples X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- 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`: The Hardware packet copying, - or ``ioatfwd`` application demonstrates how to use IOAT rawdev driver for - copying packets between two threads. - * :doc:`Packet Distributor`: 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`: The Hardware packet copying, + or ``ioat`` application demonstrates how to use IOAT rawdev driver for + copying packets between two threads. -- 2.17.1