From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6AAC14596C; Thu, 12 Sep 2024 10:13:44 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2E47E4029F; Thu, 12 Sep 2024 10:13:44 +0200 (CEST) Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on2056.outbound.protection.outlook.com [40.107.96.56]) by mails.dpdk.org (Postfix) with ESMTP id 13BCE4025E for <dev@dpdk.org>; Thu, 12 Sep 2024 10:13:43 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=GorMAJo2IqJa8q5v4YYj0lBFeXUpzgwn6ArY+t/R7y3IjygGveSXPoUb0uINhdDzha7q53D7Y3gQWeQL83dwQO8rtxZXSPQzA5kDCnmd8dDZ1llcoILbO5Nx3tB8ANsGuEn6Jy4YZVoeZ4Y/pLWkHCoGFfjo4LteDUYOlLnom9mMn4lzT/kOm+zfDObN4JrnOvJdWyPhkSlOVhkRvSQzEKiPVXQoGoWBUpwIrTaRbBTbhyY1OlqJsizdvf9W5du3ITSfSDD5fAk+ZQdw1uQXd95ix4aBLdGFPid72DJJ3T6KcSzTfQzN3CLqKxPt4pDh3QljM3iz30oikVeFJBu/pg== 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=EasNzQxevUwXgD1erHOGc6uJWio0B6zC/N0QTctst6o=; b=i4zXqOi6SmpFtYZPykZuS61fjG0r7O0FioHy57cKB9CgB5Tepvcp40k+qSzNA7vDGiK5uzFiEH6yrSWdOEaP0vZi6oVXkoqWogj2B7BArHyD2Zkoh7YYJ6ZC0nK/N1928W7vTSzyAy4mHdkT5nTOfre7BNaKz7P077S1iMOb44Mtzu/g3SFIH9cJjixiEwViQS+VZHZvRgS9C7aeq1LMcv/7oy5/j2eKHujmfougR7B0fndJQU4Yw2p8GhrpVivAjYPykSKldcE2A8CWY4CLxgYV8RybZ1LZ8wt1kcTMhV4Gsd9PiPQ1VIUOXMuH7x/BILNqEu3lqCOdnPyTF+2VNA== 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=EasNzQxevUwXgD1erHOGc6uJWio0B6zC/N0QTctst6o=; b=1biUsFP7DuqSl88fFbKDJXx76D2sAjRANLtbKAeJrEH/+Od3YtttEjXiuuKa3K46IXibw4dmDZchhb0oJbfecSMEYg69H7/c6fToQtIG8csXFmsPHau18pcyQlbs7vKb+JWiGifIu9hFjAAUo4F4K+q9nFMqdf13vmUA5mCrgFY= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=amd.com; Received: from CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) by DS0PR12MB8017.namprd12.prod.outlook.com (2603:10b6:8:146::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7918.27; Thu, 12 Sep 2024 08:13:38 +0000 Received: from CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::ebfb:2f9f:f9ca:82cd]) by CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::ebfb:2f9f:f9ca:82cd%4]) with mapi id 15.20.7962.016; Thu, 12 Sep 2024 08:13:37 +0000 Message-ID: <1f0665f9-4fed-4880-bbea-51781a2d9710@amd.com> Date: Thu, 12 Sep 2024 09:13:33 +0100 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v3] doc: add new driver guidelines To: Nandini Persad <nandinipersad361@gmail.com> Cc: dev@dpdk.org, Thomas Mojalon <thomas@monjalon.net>, Stephen Hemminger <stephen@networkplumber.org> References: <20240814190901.14912-1-stephen@networkplumber.org> <20240910145801.46186-1-nandinipersad361@gmail.com> <85f2e676-046b-4f2d-8c31-d0a5532fda6e@amd.com> <CAAKk0T7evQaQb78E_qKWeRyUE94Luq4wdJFkakHU=M+Z3Q+tag@mail.gmail.com> Content-Language: en-US From: Ferruh Yigit <ferruh.yigit@amd.com> 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: <CAAKk0T7evQaQb78E_qKWeRyUE94Luq4wdJFkakHU=M+Z3Q+tag@mail.gmail.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-ClientProxiedBy: LO4P265CA0030.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:2ae::15) To CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR12MB4294:EE_|DS0PR12MB8017:EE_ X-MS-Office365-Filtering-Correlation-Id: c2d5a4e2-a374-4672-6f10-08dcd302cd97 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|1800799024|376014|366016; X-Microsoft-Antispam-Message-Info: =?utf-8?B?bTNwaVUvVjlXY2NkMjlrWkF2WklPQ2R6cWZ3K0JrWnE3Ymc0c2pnSTJsZnIx?= =?utf-8?B?cC9MQ1djL1lwaWFDYzZDa3pjOXZoQk9mUDVlUXVrVzNJTFJlZmU4dU1lMnpW?= =?utf-8?B?bGtjVnRIS3hIVVpyOVkyeStIUGpJeFcvb3JSNzJiZ2szVzFLRUNUaXZHYURj?= =?utf-8?B?M1RDUnY4NzZtNmloYnlNM293U2d1b01vRzdXSk1GSkZ1OXRmZ3dCQ2x5ZlRJ?= =?utf-8?B?bXZ4MGx0UFE0cThSanJhMHV5OTBwbm9rWGl3NXIrNlJrdFVXYURNRmF2NXhO?= =?utf-8?B?K3RJUVBRT1BRNER0Qk45VDA5MWIzdC9idTIzRk1IRlc0NVV4RXdDNnZidnZK?= =?utf-8?B?OThLazczSnhrRFB1eEV3US9TRWtyelVBZ1BMaEZVcjJMWEFLWXNjRmVRTW5p?= =?utf-8?B?dWJPaDRUclJjc3UwZGFMaVllVjNlTjlzUVdRbHJjWDUxZUl3OW8rczBIbEpl?= =?utf-8?B?QTA2R3oyTUZCL3pvVENZenB5RU9aWGxGRXBYUUFqUjQrMlRDczJ4dmtkSURX?= =?utf-8?B?UEtYWUh6L2c5UnZVdEI4V3FtRnNYdDUyMlpXL0tSNmZvZldVNFV0ZGZqRjZH?= =?utf-8?B?UHFIcXlKSHpXOVp4cTVYOFlmSFVVcEpBcWE3ek1uTDd6ZVVSbnhGMkw4R1VT?= =?utf-8?B?em5PbUNrbllWT2dsMnFrZGZoR2RmSmtURlhIcHZlMWF2MWo4Q3F3RW1CVTgz?= =?utf-8?B?ZHV3ckV0RGRFSE52TVY2V3IrSklWdEEveEZRbkg4cjhHbjM3TFRaSDRVQkh2?= =?utf-8?B?b2JSRmV0b29JNGxTZlNsOUFuaFJtUUZyUlBFSmhnYzFoVEU2VEtnaDVCWEwy?= =?utf-8?B?U1V1SGhSZWdIaTRud29hVmhaNjVYY2lmS0dhdUNGczdUZFhra1lCNTZmVXJ0?= =?utf-8?B?dGlrZTdKQ0srb0hJMklqZlV3NGU5dGRyQXhyN09HSkYvaE1ZT1pmT0o0VFRM?= =?utf-8?B?bER1ODRPRnZ1d2tLdm9rNUdGWExlUG1vclhOZkIrUUplY3JUYXlLVWdsdUdJ?= =?utf-8?B?Rzc2czhyVUozYjJ6R0JNS2E5bitxcUZ1UzRDVEM4dWk4NGQ2bERoRXpDWTJO?= =?utf-8?B?cEMwRExNZjRvTEI0YVBHbEJzSm9xRlo0bGRid1l0cnFibTMrTktVZ0xBci9I?= =?utf-8?B?ZHkyOVZ0SldXemFFZnF3WEFzRDRPV1lzcTBtY09ab2czZzBEcGc0U2x3eldW?= =?utf-8?B?SFkvWGJsS0hDQTl3d2RCNk5zaXc2dFBnNk9tY29MWU9PeFFSUXRWTG9NTU1m?= =?utf-8?B?Y08rQjI4Zmp6bk9VSW5QNHRvbFc3MlE5S2tzVzdVNmNySGFNbjg2cEQ5anNs?= =?utf-8?B?aHJDaEhyYWp6VFg0cm84czQ2Yzk5V1BqYUtrMzNVaWRwUGdnWTlhbjlITm1q?= =?utf-8?B?Uk5kY3Q1bG1WMGRNbEczcnUxUENDU3dkaUhFNHRBd2MwSW1Wc0JPRUM4U09Q?= =?utf-8?B?aGZPRlZxVjdNd2xwUlZjckZVdzZQYUEzMEx5azAxNUw3R0JaNVFEUEYyTEdK?= =?utf-8?B?SlVwNjJNNzVTd09qUnBFQ2dRV2RmSlN2TXhOUUhUVTgwWGFtdU1sZUpGRHd1?= =?utf-8?B?V1RkSlY5RXBOY2UyR2F5ZFI3K3ZSWGRhNjRzQ09aSXJRMjFYMEVEYmd5ZjFy?= =?utf-8?B?cHA1b28rb1Z2UFBpVlhrZFRnVHU5dE42aXZCNXdWQmhQa29vNC9JVTZPTGww?= =?utf-8?B?L2lsQzhxZzdKdVpBUWhEU3lEQkxhYXBpaklyNDgybHI1eXdOTE1FaVBPd0hX?= =?utf-8?B?SUVUVWxocktsZzRvYnVhQUpxYXUwZTFVVkg3ejhwalhEV0hqcmFSK3VKUHpU?= =?utf-8?B?aS9GQUN2SS9RekszM3hWUT09?= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:CH2PR12MB4294.namprd12.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230040)(1800799024)(376014)(366016); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?VGxJVFRnWEdnd3Zvd2lHakZ5VzRXU1YwOUdOMldDTWxjc1BrL3FGYWJUWjRr?= =?utf-8?B?S2xPUDYvdTJHMWI2d1VwRlcwbDNCRzJ4TE9ZR0NISzVDVlJtMzZHVDdUMnFF?= =?utf-8?B?VjIzYlBOblRrTVRQSjJmRUFZQXhlRTlTLzFmanl1Y0N2cTgxZldLOEticUxO?= =?utf-8?B?bzZQT1pkQjBpaSt5Z0tYeWxEZWozRENQRTh6b2pxZDUrZHBLYm1xV1BGU3Qy?= =?utf-8?B?akQ4STBDS2tMUDB2eEpjQVBPdlh3REpPMXI5NWw3enVzT2d4aG1FYVVLY0tC?= =?utf-8?B?czRiMVB3c09WSVpNYllWejl1Rm53TFk5YlgwZVczYUhQQlRtZTJGeVhJSGZO?= =?utf-8?B?MUNFTkJaU05oMEd3b2c0eU16VzU0V3JUYXZ6aGZLcDFsY0dHVTZBczRyL1V5?= =?utf-8?B?VnB2YTk3N0Jib3JBenpoZ3BMeXRoK1BnTlhXdTQ4TGNtTXN0THEwYmlSS1pR?= =?utf-8?B?Ym4wY1A0Vld1QStwUGZsWUVBdENITVpqbkQwSnhrc2EyaWFOaGpTWHdhemdM?= =?utf-8?B?RXMwWFNCcGNtSWU4MCt3S2ZxcUsydWgvcjlXTFJlMnUzTHRBeStLeWlwVnAx?= =?utf-8?B?a0NhSG5xblR6dkcyVHYra3pMRzBUcm5LU0NWVHRFdnFPZHFrZmF4VmF4YzVU?= =?utf-8?B?cm1rRXMrUlZkVjFyZjF1N3kycy84UEhBL3RwdzJEMVVKWUZmYUl0eDdDZlIr?= =?utf-8?B?Mml5NGY2ZnkrdlZKazVuRDRZRHBhMzFFbEttbEtnMFo1MHZtQ2RTZlZVVkxJ?= =?utf-8?B?WmZlMlpTTFE5cUdOK2d0SjJ2VWllazIyTlM2dXdWUUVEZEFLVFM2U1ZmcVZl?= =?utf-8?B?cWhzay9qUGd0YTZTUkNueDJ1WXhhTTIvTWRJWXBScUg2Y2JpTEVlMWlOQVBI?= =?utf-8?B?eWE5bjA1OXUwdzFycFRIZHl1d1RqUm5mNDhzUUhvcmZFdTQ3bjBTdENoNkt5?= =?utf-8?B?K0dnaGVLS3RFcXNSbTNKN2VQbFBTcE51dU9Lc1NWQ0lVZ3YwMCtvdkFiWWQz?= =?utf-8?B?Yld0cmlWOEFyenlUK2VDSFErT2s0Z0pVa214cnU0b0JQcnovSTc5dGg2VlRH?= =?utf-8?B?b1pEZUxTaXI1QjBaSDNpa1lIM0R6WHhwZ2o1UjNmQ2xGUVZQWmM0Y1ZGajF2?= =?utf-8?B?dStZcmZ1eVhxNEFwMUNUYUVWSjFCeXhYWFhwR0wya0lEdW9iT0c4Z1BHM0JO?= =?utf-8?B?SzdKQ2JtT1lpOVIwY0RxdHZDSVBVRit3ZE9YckpMTlNtMDhtdVNEMEh3RDBz?= =?utf-8?B?NHFFOTRrUXY4SjM3NjFBa1lsbDNTcmZvMkthVnF0Z3VUanlvY2RnMy9TZDZw?= =?utf-8?B?T3ZXZFJ2OUlmSit6VWVyY3FuRTh3QWhjc0VrZU4yT0tDVzhSNHphZU1GVG8r?= =?utf-8?B?a0w4ZVprU09XNnRORXNrb05hRTA1a1IwN1BjWFYvQjZlTXVzSUw4eWR0UWIv?= =?utf-8?B?NEpXZVhrOEh3K2ZrMFdwb3hZN2dWeHpEbnBEbndzTFo5eHlaSkN4cTdzdTBT?= =?utf-8?B?ZS8xMmtydjk5TDh0c3RweE52Y1RaWjZaUTc2ZUljZUF1b1g1elpVeFV2ZHZt?= =?utf-8?B?azJKMGpsTHN1QUFEZWxLUHhUUCtEc2c3RDJVQVYwUlZSS0JkeTVYMFR6UkxY?= =?utf-8?B?N1cySUFLYThxVWFnVndxNlhtckVlSHBEL2lrMHAzWko2LzFCamxleDVjaFpC?= =?utf-8?B?azAzdkJkYkFyZE54L0dYbGg2SUM4cXZESkFlSk9PMjc3Ym1yeTJNV3liUUha?= =?utf-8?B?Wkh4SlFNUlpwRng2cG5wQktXcDVJZWNBcjdNUDlyeXFzU2hwUWJmaWwyQnJz?= =?utf-8?B?S3BIb2tKRmZ6aGxDbjNNK2F1U3IxaTFVaFlHZGE3R0U2TVpRbC81YkxVdDhG?= =?utf-8?B?WWpEY0FzNUZQeEhUanhtTVZlaFVubENtT0xGTTlCZHhqTitOZjFYV1JkTTlZ?= =?utf-8?B?Ty9FRVhNU01KMEZhYTlEdjlxcGt5WTNneW9vMks2ditwQVdhdVpxV3R5NkM3?= =?utf-8?B?T0NXbXlrYlVwc2pKdGE4UmZpT1JnTVlNOXgrS212V002eGlYRzZFaHA5bTdF?= =?utf-8?B?ankxSy92RGl2Q0JXalgrZDlrR3N2RlVEWkFJWkhhSlB3WGF0SUFpVjJkUXFr?= =?utf-8?Q?P1n9gxTj/Y8mNeHhYnmNd33Xv?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: c2d5a4e2-a374-4672-6f10-08dcd302cd97 X-MS-Exchange-CrossTenant-AuthSource: CH2PR12MB4294.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Sep 2024 08:13:37.7936 (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: Yjl0+7wnuniT7QP1ly1cmC6yjkzNLJ6dtf4Ym++5LmGTR22BHpF2oVHElFVlcsj9 X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR12MB8017 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 On 9/11/2024 5:04 PM, Nandini Persad wrote: > Hi Ferruh, > > I will work with Stephen on this. For the tone of the list, I believe we > can try different ways to make the tone more friendly, while still being > concise. > > What about something like this: > # Avoid including unused headers (process-iwyu.py). > # Keep compiler warnings enabled in the build file. > # Instead of using #ifdef with driver-specific macros, opt for runtime > configuration. > # Document device parameters in the driver guide. > # Make device operations structs 'const'. > # Use dynamic logging. > # Skip DPDK version checks (RTE_VERSION_NUM) in the upstream code. > # Add SPDX license tags and copyright notices on all sides. > # Don’t introduce public APIs directly from the driver. > > It's slightly more friendly. > > Let me know what you think, I'm open to trying another way. > I think above is better. Another option can be separating it as "Do" and "Do Not" list, as following, do you think does it help, or makes it harder to understand? Avoid doing: - Using PMD specific macros when DPDK ones exist - Including unused headers - Disable compiler warnings for driver - #ifdef with driver-defined macros - DPDK version checks (via RTE_VERSION_NUM) in the upstream code - Public APIs directly from the driver Suggested to do: - Runtime configuration when applicable - Document device parameters in the driver guide - Make device operations struct 'const' - Dynamic logging - SPDX license tags and copyright notice on each file > On Tue, Sep 10, 2024 at 5:16 PM Ferruh Yigit <ferruh.yigit@amd.com > <mailto:ferruh.yigit@amd.com>> wrote: > > On 9/10/2024 3:58 PM, Nandini Persad wrote: > > This document was created to assist contributors > > in creating DPDK drivers, providing suggestions > > and guidelines for how to upstream effectively. > > > > There are minor differences in this v3 and v2, isn't this version on top > of v2, can those changes be from Stephen? > > <...> > > > + > > +Additional Suggestions > > +---------------------- > > + > > +* We recommend using DPDK macros instead of inventing new ones in > the PMD. > > +* Do not include unused headers (process-iwyu.py). > > +* Do not disable compiler warning in the build file. > > +* Do not use #ifdef with driver-defined macros, instead prefer > runtime configuration. > > +* Document device parameters in the driver guide. > > +* Make device operations struct 'const'. > > +* Use dynamic logging. > > +* Do not use DPDK version checks (via RTE_VERSION_NUM) in the > upstream code. > > +* Be sure to have SPDX license tags and copyright notice on each > side. > > +* Do not introduce public Apis directly from the driver. > > > > API (Application Programming Interface) is an acronym and should be all > uppercase, like 'APIs'. > > Overall the language in this list is imperative, I think it helps to > make it simple, but I am not sure about the tone, I wonder if we can do > better, do you have any suggestions? > > > > + > > + > > +Dependencies > > +------------ > > + > > +At times, drivers may have dependencies to external software. > > +For driver dependencies, same DPDK rules for dependencies applies. > > +Dependencies should be publicly and freely available to > > +upstream the driver. > > + > > + > > +Test Tools > > +---------- > > + > > +Per patch in a patch series, be sure to use the proper test tools. > > + > > +* checkpatches.sh > > +* check-git-log.sh > > +* check-meson.py > > +* check-doc-vs-code.sh > > +* check-spdx-tag.sh > > > > `check-spdx-tag.sh` seems moved in v2 to "additional suggestions", I am > for keeping it here, as "additional suggestions" are more things to take > into consideration during design/development, above are actual scripts > that we can use to verify code. > > And long term intention was to move this "tools to run list" to a more > generic documentation, as these are not really specific to new PMD > guide, but "additional suggestions" will stay in this document. >