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 2AFB545A1F; Fri, 27 Sep 2024 02:19:27 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A9B3E400EF; Fri, 27 Sep 2024 02:19:26 +0200 (CEST) Received: from NAM10-BN7-obe.outbound.protection.outlook.com (mail-bn7nam10on2044.outbound.protection.outlook.com [40.107.92.44]) by mails.dpdk.org (Postfix) with ESMTP id 929994003C for ; Fri, 27 Sep 2024 02:19:24 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=Ki+pjWZsZBgMbqft3XP+xeWFILrISLIY/9uvwHXilD2N3d3OpbShe+qHhUV2r9PwcTWv6bzUCwxiPpBU5sM1NWlN+IqaQxDLX0ZF5wEIgVz5TGAunkzYKb0g2hdn+YufIiRPDn5WiELlpcEz9WcqVrrGZxQuSc90oePFWES/Z2lVQ4aY9F8mVfKg4pFNNR0Dm1xzVJNhKP14gI1nyjj9wKKVPXl3xsF0+TKRQwDive2vrSGjN5NNg/NCivNGIEVDkMDyzQQze8WJEeZ45ksZkDFdeJ0r175AmtE8liMiHd4o30BTd770+0rKOhiEpJcSRf/AvcAGb9DSMcC5ToyZHg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; 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=Csi0X2bFswSrZ5ioMTAJd4zu8A5G6zUE9A8aXAiqjpM=; b=lMQxFXcBi9HQq0b0+UYACZGpS0zmJ/z0Ad/GE/I2WMlWQihXwiHbdV9xirXCCqFAxRAQfE36qRWXfWXbGr1FcUalJM8xiWykGLmjCllgd2AUYyTbB3RRKyPpyIdRy2YVlHsDy9JpLYlyX5ACUVhEyzrB549Y+DMTUlZ17sh9Qapa7clrzrs12+U8jTGoUt6wWM8eYnV3lB0RCp6aUMzJ3GhVscWEhd4BkwrapnAZPlNvvLEKmGL/5Tvd/2W/jkGSvyAK56G4BFEm1jr/XBm8N8JH6SKo8frerdwun4oR1ze4A2WzCfOecoloQiR6xdTlnD9tZYjaRM981AUjceHu+w== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=amd.com; dmarc=pass action=none header.from=amd.com; dkim=pass header.d=amd.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Csi0X2bFswSrZ5ioMTAJd4zu8A5G6zUE9A8aXAiqjpM=; b=jIyOOhW3AX+LeVNHu64DNtdkfRld+XhbLsKujONS0U2dFqEIxieNGMm+1SKra15QMwmmiPTP/qUuNKRrHlSBQskek3gSIEdlgFqKfIHHGDVrDWeB6wD5/l657WUKzENpT24veoD2fdqu0CDsdrx8QSJkC8heis5aUbnYgowVtfI= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=amd.com; Received: from SJ2PR12MB8830.namprd12.prod.outlook.com (2603:10b6:a03:4d0::9) by MN0PR12MB6126.namprd12.prod.outlook.com (2603:10b6:208:3c6::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7982.26; Fri, 27 Sep 2024 00:19:21 +0000 Received: from SJ2PR12MB8830.namprd12.prod.outlook.com ([fe80::c3eb:df02:eaa9:2055]) by SJ2PR12MB8830.namprd12.prod.outlook.com ([fe80::c3eb:df02:eaa9:2055%4]) with mapi id 15.20.7982.022; Fri, 27 Sep 2024 00:19:20 +0000 Message-ID: <37667f4b-1730-4006-b084-6c32e85979f3@amd.com> Date: Fri, 27 Sep 2024 01:19:15 +0100 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v4] doc: add new driver guidelines To: Stephen Hemminger , dev@dpdk.org Cc: Nandini Persad , Thomas Monjalon , Chengwen Feng References: <20240813201250.9383-1-nandinipersad361@gmail.com> <20240916162856.11566-1-stephen@networkplumber.org> Content-Language: en-US From: Ferruh Yigit Autocrypt: addr=ferruh.yigit@amd.com; keydata= xsFNBGJDD3EBEAC/M7Tk/DfQSmP1K96vyzdhfSBzlCaGtcxNXorq4fALruqVsD3oi0yfyEz9 4YN8x7py0o9EL8ZdpOX0skc0AMCDAaw033uWhCn0GLMeGRKUbfOAPvL6ecSDvGD7CJIO9j0J eZUvasBgPdM/435PEr9DmC6Ggzdzt8IuG4PoLi5jpFSfcqxZFCCxLUDEo/w0nuguk2FTuYJg B2zEZ4JTBZrw7hIHiFh8D8hr6YA6a5uTofq1tr+l048lbtdFUl8TR0aIExVzE4Z8qKZlcE+9 RQaewjK5Al1jLE4sHdmd3GN+IvgDF3D/fLsi25SKJDeGSdeHkOmaX0qGeM4WKIfU6iARRCiQ N3AmBIxZ/A7UXBKLaOyZ+/i3sE6Wb53nrO4i8+0K2Qwyh6LjTeiJAIjYKN43ppxz3DaI+QwQ vI+uyHr4Gg0Da9EPPz/YyKauSeOZCfCB5gIfICO0j6x0SCl8uQ2nLpjxcZkf0gjcwUzP3h+S 3x6NfDji9YEij0zczW/dcSpGgZ6vsFpPrtnP9ZXy6J53yp0kJtOJoOlkEFFdU2yCZnCDseum CoudmGLZVvS0/DzHDJejq+3kK3FDGktZBOxZIIpal+nFqS7lVgOZc4+huVv3jyhzoAUOEyXA XK5j6o7g8STUY+z33QNnHpdLvecMwuzmvqy0jR54yAbZ64mB9QARAQABzSNGZXJydWggWWln aXQgPGZlcnJ1aC55aWdpdEBhbWQuY29tPsLBlwQTAQgAQQIbAwULCQgHAgYVCgkICwIEFgID AQIeAQIXgAIZARYhBEm7aYjps5XGsPHCElRTPtCKKm/6BQJkdyEEBQkE3meNAAoJEFRTPtCK Km/6UdcP/0/kEp49aIUhkRnQfmKmNVpcBEs4NqceNCWTQlaXdEwL1lxf1L49dsF5Jz1yvWi3 tMtq0Mk1o68mQ7q8iZAzIeLxGQAlievMNE0BzLWPFmuX+ac98ITBqKdnUAn6ig5ezR+jxrAU 58utUszDl16eMabtCu76sINL5izB8zCWcDEUB4UqM8iBSQZ7/a7TSBVS0jVBldAORg1qfFIs cGMPQn/skhy3QqbK3u3Rhc44zRxvzrQJmhY6T1rpeniHSyGOeIYqjpbpnMU5n1VWzQ4NXvAD VDkZ4NDw6CpvF4S2h2Ds7w7GKvT6RRTddrl672IaLcaWRiqBNCPm+eKh4q5/XkOXTgUqYBVg Ors8uS9EbQC/SAcp9VHF9fB+3nadxZm4CLPe5ZDJnSmgu/ea7xjWQYR8ouo2THxqNZtkercc GOxGFxIaLcJIR/XChh9d0LKgc1FfVARTMW8UrPgINVEmVSFmAVSgVfsWIV+NSpG9/e90E4SV gMLPABn1YpJ8ca/IwqovctqDDXfxZOvCPOVWTzQe/ut767W+ctGR1kRkxWcz470SycOcY+PW VRPJd91Af0GdLFkwzZgNzkd6Gyc9XXcv4lwwqBLhWrBhqPYB0aZXIG1E/cVTiRp4dWpFHAFD DcuLldjIw93lCDsIeEDM9rBizGVMWEoeFmqSe7pzGTPXzsFNBGJDD3EBEAC8fBFQHej8qgIG CBzoIEd1cZgPIARlIhRudODXoNDbwA+zJMKtOVwol3Hh1qJ2/yZP11nZsqrP4fyUvMxrwhDe WBWFVDbWHLnqXMnKuUU1vQMujbzgq/4Rb9wSMW5vBL6YxhZng+h71JgS/9nVtzyaTtsOTrJi 6nzFSDx6Wbza2jYvL9rlK0yxJcMEiKwZQ/if4KcOesD0rtxomU/iSEv6DATcJbGXP6T93nPl 90XksijRKAmOwvdu3A8IIlxiSSVRP0lxiHOeR35y6PjHY2usfEDZZOVOfDfhlCVAIBZUZALv VmFOVSTYXeKgYa6Ooaf72+cHM3SgJIbYnevJfFv8YQW0MEAJ/IXE7B1Lk+pHNxwU3VBCrKnA fd/PTvviesuYRkrRD6qqZnINeu3b2DouVGGt2fVcGA38BujCd3p8i7azoGc7A6cgF7z9ETnr ANrbg1/dJyDmkDxOxVrVquTBbxJbDy2HaIe9wyJTEK2Sznpy62DaHVY+gfDQzexBXM10geHC IIUhEnOUYVaq65X3ZDjyAQnNDBQ4uMqSHZk8DpJ22X+T+IMzWzWl+VyU4UZXjkLKPvlqPjJk 1RbKScek5L2GhxHQbPaD76Hx4Jiel0vm2G+4wei8Ay1+0YRFkhySxogU/uQVXHTv63KzQMak oIfnN/V2R0ucarsvMBW+gwARAQABwsF8BBgBCAAmAhsMFiEESbtpiOmzlcaw8cISVFM+0Ioq b/oFAmR3IPsFCQTeZ44ACgkQVFM+0Ioqb/qINhAAtcor9bevHy22HvJvXX17IOpPSklZJAeQ Az43ZEo5kRlJ8mElc2g3RzYCvL/V3fSiIATxIsLq/MDtYhO8AAvklxND/u2zeBd7BkRZTZZX W1V1cM3oTvfx3LOhDu4f2ExQzCGdkzbXTRswSJIe1W0qwsDp+YPekbrsKp1maZArGeu+6FuW honeosIrWS98QJmscEhP8ooyJkLDCCOgEk+mJ/JBjzcJGuYn6+Iy/ApMw/vqiLGL1UWekcTA g18mREHqIR+A3ZvypIufSFB52oIs1zD/uh/MgmL62bY/Cw6M2SxiVxLRsav9TNkF6ZaNQCgn GqifliCEMvEuLZRBOZSYH2A/PfwjYW0Ss0Gyfywmb2IA990gcQsXxuCLG7pAbWaeYazoYYEQ NYmWatZNMAs68ERI2zvrVxdJ/fBWAllIEd0uQ4P05GtAHPdTIDQYp545+TPV7oyF0LfXcsQs SFVZE6igdvkjfYmh+QOrHGZvpWXLTmffVf/AQ81wspzbfxJ7sYM4P8Mg5kKOsaoUdyA/2qVe cMh1CLUHXF1GlofpGbe1lj4KUJVse5g3qwV7i9VrseA8c4VIZewdIjkzAhmmbxl+8rM/LKBH dZUMTzME5PFCXJIZ83qkZQ795MTe2YScp9dIV7fsS5tpDwIs7BZNVM1l3NAdK+DLHqNxKuyO 8Zk= In-Reply-To: <20240916162856.11566-1-stephen@networkplumber.org> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-ClientProxiedBy: LO2P123CA0070.GBRP123.PROD.OUTLOOK.COM (2603:10a6:600:1::34) To SJ2PR12MB8830.namprd12.prod.outlook.com (2603:10b6:a03:4d0::9) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ2PR12MB8830:EE_|MN0PR12MB6126:EE_ X-MS-Office365-Filtering-Correlation-Id: 5b5d8316-d297-400d-1c9b-08dcde8a084e X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|366016|1800799024|376014; X-Microsoft-Antispam-Message-Info: =?utf-8?B?RlJDY2pxNWV5aUZpcmk2amtVZlJJcVdFVlpkN0l4STZqVG1oc21QNUMvRTN6?= =?utf-8?B?UmJMVXdhdlVpT1VyYnhyWU55bEppY2dHaElqa0djVER1V0k1QWtTV2hFekd6?= =?utf-8?B?dGh3U3ZreG9TenVLa2VtVmMrYk1xMFQwa2FOVmx0VGZiMkVjVTFkS1ZReVdm?= =?utf-8?B?SWRDSXNDUWdocmR3ODNWYkJLVDE0ZHBQdEdDVnZXTkh2T2c0UGE4b1o0ekJY?= =?utf-8?B?eWs3UDZJM0g0dTV6ay9CRmlBLzJvbFgvVlRDYUltajVOckk5N3BzUVd3TGhL?= =?utf-8?B?cStJc0RVNXNDVFM3Ly9EQW5xT1BhR3padlFDcXozQ0lBUFlhU0FYaFoyc085?= =?utf-8?B?TFJWSFczY2xVTmZ6R3BxdlYyalllMjc3RjBtOFlLUTNEc25WNGEzajZETW5D?= =?utf-8?B?YmtBd3NxOTlPZ05PRG1zNHhIcG5lVUJKWDFxLzVNcDZqTE15eUxCcWlQbFMv?= =?utf-8?B?ZlYrWlY3WG1iRnlmYm5INEFueGRoS0Y5elRlZDF4Qlc1NEtZVVhkYjNndXNN?= =?utf-8?B?ZlVueEtMbW53LzIyNzA3YXBYakZsNExKVmptSEN5OXdTd1JJYlRSTU5LVkkz?= =?utf-8?B?UzVOZ056eG5Bb3lIWVg0eDdWMVQ0Z3ZsbGdxMEdZTEcxR1dQZWxPaC9qbHF1?= =?utf-8?B?OTJjTHU2bWl6SlN2bVFDZTFGNHBOU3lVOXZxVG9TVzZyWGtKZGtGTDJQNDFv?= =?utf-8?B?WTAwMnBGSXFnVFBzNENQL1QzaW1zMUozd1U5NUNqTmNsZytBREVSQSs0ZkRx?= =?utf-8?B?RmJnTC9LU1hjOWhDTi95RStpdDVnL2dJWmpXZEg5aW9od1VGZHNaMEV3VzJj?= =?utf-8?B?NHhGRGtrZ3Q5a1RKWmszdlltaHVqcGpVdVVzWWU3ZkZydkc5TUd0WmtoNkQ1?= =?utf-8?B?eUhQRDlCSlJvUkRwT09LYTVWdnBXa1UxQXJmSy9QTXZXeUFnQlo5a21EdVcw?= =?utf-8?B?QU9oQ00xdEdYNDhUSzhicllkR05uRGVqQ2ZDQ201N3VJdThMSTNDYTZEMzMv?= =?utf-8?B?U2FhY0RWeVY0RUh0eDl0WHhnVU5RL1g1am5KaHRPekNCMm00VFZjdVhiZE96?= =?utf-8?B?L1g5QWExNXdtVTVjNDNMWGkxRzV0ZTgraUMzd0NmQ3RUbHUxN2VJYXUvbWVu?= =?utf-8?B?YlNpRzJlV25EQVUyRm4wNENhemRPQk5EZ2Irbjd4UnRQYm85cDJKV0UzeWRk?= =?utf-8?B?K3hxWmxqZ2Y5WVc4MWhqREczSVFRVTNvOVgrSHozV20zRmphZDhaaTRIeWM0?= =?utf-8?B?SmMwNi94YVBVSGQwUVFLU01laUdyS3RGUjQzb3lNOTN4bnhaTDU5eEt0QTl4?= =?utf-8?B?aU8vVzJzWGhwdGUxclE5WTB5Mld5V0hSTUNRbS9KRXJjTCsyMGsvbHZMdTR6?= =?utf-8?B?SENheUtkT2dwcXlzZ0ZSejFENGtZMDJvTW9Wei8yeU5DeGttci9KcEVRdzVU?= =?utf-8?B?MDdUTSt2VnQwQ0VHNThwY0lkb1puR2JIZ3NmS1pQTFlISHl4dkFwbmR3VUtZ?= =?utf-8?B?LzgwaDkrMGVOOGpWUGpER3VtRDJYbGpET3NsQWhTYmRROVBhemlSSHMrM2lo?= =?utf-8?B?V0lrTk1OT3Z6cUlCYkJjUWwvNGUxM3lUdWpOdllwMHBtbHdneWNSNUNkS0Jt?= =?utf-8?B?bXBPZktuS25LUndGR2JZNHlITklmbVd0TFVwY1IrWElrNmpXSzc3VWh4OGpr?= =?utf-8?B?Y0gyOHdLaVhBRk5FRFRvT1ZKLzRVLzB2dEIrWnNrQThDYXJ4TitITER3PT0=?= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SJ2PR12MB8830.namprd12.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230040)(366016)(1800799024)(376014); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?YjQrOCthL2FFQW02bmJaMnNqS0hSdThXTDQvTmZXUU1RYi9tQ2E2bGtSTmt2?= =?utf-8?B?ZDUxMWt6SWQwcG1vdlZHNUcrL3VSd0ExWWxOWXVDTU5VVzVhNTZvV3AyNVpu?= =?utf-8?B?aXdUcWNjR1JENnVrTzhkNjc3Q0ZhSEdvWXJLb1NTdnFNRWVEeHBoWDZtMzAr?= =?utf-8?B?dTN5SURrQVBrMFJyLzlkVlVTSUtjUXhnMVhRblQ2WVZYTUVRRzNONXVYUUE5?= =?utf-8?B?UHYwRy9XSHBGNkhCQzhhVmVIRGtYWUsrSm4rVVFFVWN4ekYzandSVmwzTW8z?= =?utf-8?B?QndPSFVmNytTQ3c0NUFDQW1HTFh0OS9LUXdubnZrVEVVRjZvMklRVHJtRUpV?= =?utf-8?B?eG5DZU1hODdzcjRtbWYwVkEyc0poek9ybnI0dGNjLzBQTktSOWVxU1dvbHVS?= =?utf-8?B?MjNEbTVLOGUzY3J0bXF0WnNCQTZMaW02ZHJ0NDVLbTJrcWYxR1Z4dFhZMmJs?= =?utf-8?B?RkhkOXhXRElPZWRBWmhQaEl3YzZqN3d1QlpXOWR1MGZ2aVZYTEZRVVYxaEtS?= =?utf-8?B?M3FReWNscG1BU1hieWVqNFRIa08yRUh0NURBZk95WGZqWTJVMDVuT0oyNFFn?= =?utf-8?B?OGtpQXFtMFQ5QnIweW84UjFmSDZ0bG05RStUQit0Sld1RDZnbW9pVXloSGdS?= =?utf-8?B?WnNwdWp3TEg5Z205MkZKS1N1Um5GMFRzR3lQaHREc2FYOFZscmJNQUlMa3Jh?= =?utf-8?B?TkRNUWdpZTV0c2s3ejBvWWlkRlE5VDhTVS9lTjZMNGtrT2hkQVI0N3VPQXF2?= =?utf-8?B?UVFiSnM1OXM3Slh4YTd1dVVZak41SzFkTm0yUmFQbW45UUdrNXVMMU0zbjly?= =?utf-8?B?QXdUV2RaMzA1bis5ZEJyTTJaa0Rpc0tMeGVJWFhuMHVXMzBzbUw3d2lmVnFl?= =?utf-8?B?eXIydDBKRzNiVHhNUDRZVjVtNGVzRGFaRHpvMEtoRWRiOXJYSlR1aGNSck5X?= =?utf-8?B?RzFwNzBwTFFYMVNtKzg0aVJSTWVXNWpPMTNQclpmMWNJSFpIQlIzV2NpNVp0?= =?utf-8?B?S1hsb2hLV3Fwelp5OXlJcWh2ZytXajhSMUhhcjVQZ2lvUHRZOHVsMFhieWd3?= =?utf-8?B?bTVRaHhrWW1EWGxnSkh2cmIrL3pIeERmVTd2aGpPTy9BYjNySlYrSHcrRzdK?= =?utf-8?B?SloxczYrNTdYdm92S3V5a3VUUEprZVlWODBFOVhWSUFQcTJDaU1WMjlXcSs2?= =?utf-8?B?Z1J2UVRZT3h0OFZ3SDk3eER4clJvTmVZSFRUUTlmTzRldFhDTGJZWFdPWDVQ?= =?utf-8?B?bE1jWFYwM1RtUmRSUHlsMm9RTjhVM2FQaUV6NDlDSDZ1OW9iM21LVDcwNlVO?= =?utf-8?B?R25WUUYwRlY5ZkpGUTA0ZGxReDZQRVVzbHlxdHVpUTVrNXJRRnNiNVM5ZHVX?= =?utf-8?B?alQwbjZqb2RwVTdLYTgxSEVzeWw2eFdaTlUvdW1zMFFWOWszRXBodnErSmYr?= =?utf-8?B?cUMzcTM5eFNnT2E3SUxyVGFRMXZTWlZQRTBFMzU3WHp6S1RxSXdRRzN2NU1o?= =?utf-8?B?M1ZNalNGR1FvUVNCM1ZpdHA0eHFpcmdzZzBvOXV0U2dwUWJvVjRBOWY2OEYz?= =?utf-8?B?V3VWdlVpOUJqRjNlRmZhUjFwdHl5aWhjQ2hYWE1mWUNUcU4vWFo0Ym1EL3B1?= =?utf-8?B?MzNiK3FtQkh0ZC9kdzFXbGtYbkgzNFRXVk4yWm9RN3hqR3pGNGx3MUYwSytT?= =?utf-8?B?R0s3UkUrNzM3dG11anB5VGxVVlJpS3h5TDF4NlROQi9sSy9TbUw1MFRvTUNI?= =?utf-8?B?WnRORFhhV2ZBSmN0ek0rUEgvdEdVY0lWL1g0UmxpR3JaTHpDOE44a0pEZlNV?= =?utf-8?B?OFNUYytSbmg1OVljWVlMSTMxS1BBeHRWa2JrWjFqNnNBcUhBdEl1Y2dXOEtw?= =?utf-8?B?M1NndjlNVXFvYnRkSnk1SG9KVVhzNkxEeWxrTWhMOHoxMnhHQVloWmFCNzM3?= =?utf-8?B?UVZ6RUVna29nU1JhNW9NUnlyR2dUdWdVTlJZNUtmUmdDSDhPYmpndk5yTGRG?= =?utf-8?B?ZHBYMG9USGxvNGdlUDVrc2F3REYrdEdHL3N6N1JSU08wc0ZmQjBtbCtHT0tm?= =?utf-8?B?NHdrMEswWXJMazNzQk9Gc3VsZWZYT0FyL3RhSFJhdWU0eWhtUkR4SEg2SVRI?= =?utf-8?Q?JDmK34yQDBW3gNEPJw25jt2yd?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: 5b5d8316-d297-400d-1c9b-08dcde8a084e X-MS-Exchange-CrossTenant-AuthSource: SJ2PR12MB8830.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 27 Sep 2024 00:19:20.8676 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: D51+i9+cJMqiaB+AGQqhwnnhNVXUMTpTmeBf+a275mC0zR92rNqrAiPOukocGUL6 X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN0PR12MB6126 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 On 9/16/2024 5:28 PM, Stephen Hemminger wrote: > From: Nandini Persad > > This document was created to assist contributors in creating DPDK drivers > and provides suggestions and guidelines on how to upstream effectively. > > Co-authored-by: Ferruh Yigit > Co-authored-by: Thomas Monjalon > Signed-off-by: Nandini Persad > Reviewed-by: Stephen Hemminger > Acked-by: Chengwen Feng > Thanks for the update, build warnings and format issues seems fixed. <...> > --- > doc/guides/contributing/index.rst | 1 + > doc/guides/contributing/new_driver.rst | 207 +++++++++++++++++++++++++ > 2 files changed, 208 insertions(+) > create mode 100644 doc/guides/contributing/new_driver.rst > > diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst > index dcb9b1fbf0..7fc6511361 100644 > --- a/doc/guides/contributing/index.rst > +++ b/doc/guides/contributing/index.rst > @@ -15,6 +15,7 @@ Contributor's Guidelines > documentation > unit_test > new_library > + new_driver > patches > vulnerability > stable > diff --git a/doc/guides/contributing/new_driver.rst b/doc/guides/contributing/new_driver.rst > new file mode 100644 > index 0000000000..f95d3b90bc > --- /dev/null > +++ b/doc/guides/contributing/new_driver.rst > @@ -0,0 +1,207 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright 2024 The DPDK contributors > + > + > +Upstreaming New DPDK Drivers Guide > +================================== > + > The title of this guide is: "Upstreaming New DPDK Drivers Guide" Title of the document for adding new libraries: "Adding a new library" In the index they are next to each other, and different wording looks inconsistent. We can simply call this document "Adding a new driver", or update library one title, but I think better to align them somehow. <...> > +Avoid doing the following: > + > +* Using PMD specific macros when DPDK macros exist > +* Including unused headers (process-iwyu.py) > +* Disabling compiler warnings for driver > +* #ifdef with driver-defined macros > +* DPDK version checks (via RTE_VERSION_NUM) in the upstream code > +* Introducing Public APIs directly from the driver > +* Adding driver private APIs. If a new feature is needed, it is > + better to extend the corresponding framework API > + > Last two items are for the same issue, we sometime call public APIs from drivers as "driver private APIs". First one looks simpler, perhaps we can keep that one, but I don't have strong opinion, as long as we remove the duplication. <...> > + > +Be sure to run the following test tools per patch in a patch series: > The list is missing in the patch, it was: * checkpatches.sh * check-git-log.sh * check-meson.py * check-doc-vs-code.sh * check-spdx-tag.sh * Build documentation and validate how output looks