| Message ID | 20230705095626.31177-1-hemant.agrawal@nxp.com (mailing list archive) |
|---|---|
| State | New |
| Delegated to: | Thomas Monjalon |
| Headers |
Return-Path: <dev-bounces@dpdk.org> X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 94BC542DD6; Wed, 5 Jul 2023 11:56:48 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2440440A8B; Wed, 5 Jul 2023 11:56:48 +0200 (CEST) Received: from EUR05-VI1-obe.outbound.protection.outlook.com (mail-vi1eur05on2049.outbound.protection.outlook.com [40.107.21.49]) by mails.dpdk.org (Postfix) with ESMTP id C550240150 for <dev@dpdk.org>; Wed, 5 Jul 2023 11:56:46 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=O34aTLK5qqfi8rVbbvAS5W7ibXiMK6GU4Mqvky7V5RXqmaGwrdmej6uihlI8NYwks/o0kdorrQNLu+cOoXXFgGmski+1h9RSjPuuaAN+R74nTtM9lt/EqjbHwo/UanifDj9TsUyLaj6L+8K5aeA2ZdQ3Ch6W2LWpcny/dcIoJRO47xHi/XTcVKvDjcy9nDVwL+J/NulNcHjUztx35uDdmjbUIMt2PP+xl16sAc7maxcCosAPKWflIQjkTC+FP1phWawS1URqGsvgFkb2Fg8SepAIPgupY1QooiIIbltWEnJEqM4HuY3+QI57kB+hd776tJYDKZZvRdW0KYqHEtkfzA== 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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=shHsGfkH9he3A4gklD0kDui1/QXwH5Sblh4K1dvUGPc=; b=JD4KA+zIk1yQ1edg17IEwO75GWNEyFzKVP8sBI4Xpy45zMZcnqgZtYoSNg1V0aghJzqAWHwlZHcz0uo6yyaT6hwdtM6RtI6O5e+iKHx8k5g3f9IHBZCEPT8batDyvywka0YZfduTEGWMoArNfDA6KRdxsc6WVITdcgRUvkXOF7ogwaxQm/Dht4/s0HO35gjjg/l/LpO8JFL8BJg7+Eh7vCsVh7WZlQYrh+ZrieFpcgzfsD0nHf3IyV5GIzUjqUSKvP9bgpMOzQvNAqQ1vThUtA57o4HcN7/r1eUZ3SzgcX1OIO387O0SKv0ZkFg7eJLAQydR3arj1kup363hxElAOQ== 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=shHsGfkH9he3A4gklD0kDui1/QXwH5Sblh4K1dvUGPc=; b=f4UmtB3TBA5a5VS9kg/IETZvDIfnhBxB9Gk9T+Mm2MbPxhLEReOqHeL5QGszQLIrmkhVh80pH8L9dk6pH1mMOKpK/it0fKkJyJzRMdHvshVZAwF1biuJjvFKxsH8I2rzuXr+eEHfS9K8kvYObYsEOJSWKfOp48AL4N41x4b0+Hw= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=nxp.com; Received: from PAXPR04MB9328.eurprd04.prod.outlook.com (2603:10a6:102:2b6::15) by VE1PR04MB7230.eurprd04.prod.outlook.com (2603:10a6:800:1ab::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6544.24; Wed, 5 Jul 2023 09:56:45 +0000 Received: from PAXPR04MB9328.eurprd04.prod.outlook.com ([fe80::8f04:8a71:fee6:eb88]) by PAXPR04MB9328.eurprd04.prod.outlook.com ([fe80::8f04:8a71:fee6:eb88%7]) with mapi id 15.20.6544.024; Wed, 5 Jul 2023 09:56:45 +0000 From: Hemant Agrawal <hemant.agrawal@nxp.com> To: thomas@monjalon.net, dev@dpdk.org Cc: stephen@networkplumber.org Subject: [v2 1/2] doc: add policy for adding vendor PMD specific examples Date: Wed, 5 Jul 2023 15:26:25 +0530 Message-Id: <20230705095626.31177-1-hemant.agrawal@nxp.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210526074712.9270-1-hemant.agrawal@nxp.com> References: <20210526074712.9270-1-hemant.agrawal@nxp.com> Content-Type: text/plain X-ClientProxiedBy: SG2PR02CA0083.apcprd02.prod.outlook.com (2603:1096:4:90::23) To PAXPR04MB9328.eurprd04.prod.outlook.com (2603:10a6:102:2b6::15) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: PAXPR04MB9328:EE_|VE1PR04MB7230:EE_ X-MS-Office365-Filtering-Correlation-Id: 0b5d77a6-10dd-4ea5-034f-08db7d3e2440 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: IKWv0FQtLU56aX9L2ewmc5FFCkxSxSKZLb9hwtZcFHA1CTb2dSglyGN4NU/pmxbWezQ6h67UnELALqNzwioaNkqZtnUrlZByvmVPoEdPJsZQ2vLplcDI4wGOA7ChYR0ngvi8VjiFOEBpKpDNlhAHH9ttSr3XUfxPQPiu0dizOLqkPoFkhOECfwiWrzjxj05BWRdDbEnbvBWLTKS6VvVtnzxR0hlmtY0We5lTMM81FzYgkzXsPDsNbJ0bZCisbncnoWvMZscDdDUjUhmtCBl3whIOqC3PKXhHqaZQVmgMhvYJpqx4P+DXA/4taFNKerfWwFduC1cWVJox7Q9G+UQYmQmn7xT9YsoND2a59YFmlP7Mk64stRdbVd7igapT9mfM5K1BVaD/ri3lbtf8ahex5Gzo+UuDz4/8Dwt9EO6ACNok+XflkshiL/ldsQjPHM+HSzJfipDRTcDbwD5Zo9tvNstXneF/KZVIJ1LEUvifQP8Bt1devE4nvhNDPyRO8E9yHPGTkjh9EnrURhA3V2vR6rh50z2pG8VXSSCSHKx2cpTKl7/hxEntxV72CdUkxOyWts3CepvVC3L/WD5d9Q4aFTzK3WlWLqO/sqJL0W4Ts1vKSf1esSqmTcI8nN5DTxPM X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PAXPR04MB9328.eurprd04.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230028)(4636009)(376002)(136003)(396003)(366004)(346002)(39860400002)(451199021)(26005)(44832011)(66556008)(66946007)(36756003)(66476007)(4326008)(316002)(478600001)(8676002)(8936002)(5660300002)(2906002)(41300700001)(86362001)(6486002)(6512007)(38350700002)(52116002)(38100700002)(6666004)(1076003)(186003)(6506007)(83380400001)(2616005); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: CREngoqtty9D+ldDNIKy9hMVvnl6XGqzyv+75C51yyCHcLhJadYHJuxYQUOGA6C8OynTbjVwQN9Z2aZkwJGUoqTZEy+WwhgOAw6N2Dk/m+Gph0+KBXmjqXtCO/17FuD7ByOzJ3itcGSSok6NUEmMmqKDuMICb5xOdCiJmVtd8df80cKENyd4v1a1D5uz83j1oURv5xUxwxWEVJpw6izn7MNpQL8Au2U9BMqnhges9UkAIMNEscvtvOd7sZZvTizqYikdkrmqQFe3xFxlh1AY8OISyxegPNmiCssZmzPhDmpHYV4peoljFT5pxCWMd1yKXUJvFMVCkxtHb6mxksCOoPTps7EDW5isQEfe1Rfcq1/2QJ1G3ddakK+pSrO89wqjm3LgaQz2VeN0564iRtubP0l0Vg0emggOARg+Gx1qBW0fWk+uqunBWQ2+klGBRhxfiXdp6ZSPzr/exJoqYfh+CjwsWX1PwqwcvgXdYW/NzadtyHGWbZKqplWoyzGBpDL/c758rs47uKgrZ0XpA2MqLBqW1quM2vLgJ/6XSdKYHirJi3Njx0jaSJBFWQNMS4xIHrPaGlI+TSwXzg6tNBIR52kN9XZnwqrckyiuwDM6Q/+xcNBd1LkaILcNdJKoF64HFFdUPMYUp/T9h+jnK+evmeHriRudU3q/CDupXWlywBJx8zGHVfSDJW8pBWqlxG4P3tToO4a4Tv4ZGYH1ZexxRZueuJIEy1pvd1jYSuc6Dbt6rNFK9vzNjOWWj8aOWgH1DSaY7F+KqwWF3UjBhnGVex70q5v916NKTTIffiC22j5Y6ozBxtWRYwgPZcqzzS7yfcZ5AQBfQaEyie8dORdgOYHamARTAc8qUPOt4/TLF84mVgIpP+WmLZoX5ThT+n289Dd5F64MI5SPUhtGdvA53XnPOp/NjHl9xXsH5QF3Rn8HqG7GruqNEOmBcQkvVEDNP/Ww93oCioQ0gV9QEW+2z1t6BhdV98bZzPQAk48fgUsoL6N2qWYUIFU6y0OZ/wp/WjMRquKrF/PJmUBE5n5iSGRAzbXU8dqo7UONqFnkb9NCXthya8GCQ1u2O0muVdjLWHA17+LFG9rwbE1PuLdYUM5U1YRR4gp1MXb+oePdwisrvjA7RqovbK8uMtwCqDbtQV3h2Pl4e5+a14GNuajxCRD0zCfR85SSiB6nu2/f1Gz9Xm8a0+fdn05dlgCrnEBrIJnBcc+a3K2YCyUkhDD0YmT9v4QLyEs9mvX13UbOlsfo4eFH3Uh3m+x39/4RlR5tkeIuf5WTBY0E570FutbS0dlz6o3dYCnGgIbt5OwwLhOYPew4evTMFWWwuPq3+l1ylUcH9ljHYbeZo1qbuZFgwH9FSOYOW2F86YYye5+pFbWbOwgSSQ9rk9xb369uqZpPfkQVG+wXSJv++cqaAZ2Tw89w+uAR1fwypz2AgIbgNcb3r2JBQuPIbqChM51GvlCqZ5vkRN22McVbWD2mw7MjTG/drLXPjTzOB7WHWYj4T5JKQBMZ6NKmjNwtvQpjSt2YDmACWos5YjqRvj1qC6JDI3BbeQIkQ6ygkVGpXHgOvSz5h0N7Wzs4bMUljTZaU+IAzGwN38yHFAlgLmvCrkiUTQ== X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 0b5d77a6-10dd-4ea5-034f-08db7d3e2440 X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9328.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jul 2023 09:56:45.4365 (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: 9WEx4A1TVRNkAhkbjmPcqaToDZ0BReEWPpLWBl0Xnqyl73uIUf5DQ9ZEf4EnxJBsZd6EGc6Q5JR3c10z6hIygw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: VE1PR04MB7230 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org |
| Series |
[v2,1/2] doc: add policy for adding vendor PMD specific examples
|
|
Checks
| Context | Check | Description |
|---|---|---|
| ci/checkpatch | success | coding style OK |
Commit Message
Hemant Agrawal
July 5, 2023, 9:56 a.m. UTC
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 ++++++++++++ 1 file changed, 12 insertions(+)
Comments
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.
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..