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 4C25F4596E; Thu, 12 Sep 2024 15:37:45 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id CA693427B7; Thu, 12 Sep 2024 15:37:44 +0200 (CEST) Received: from NAM12-MW2-obe.outbound.protection.outlook.com (mail-mw2nam12on2042.outbound.protection.outlook.com [40.107.244.42]) by mails.dpdk.org (Postfix) with ESMTP id 240C142709 for ; Thu, 12 Sep 2024 15:37:43 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=q5WuswIajQW16l0JAd58cnrm7OFCj+To/wMxzcGn+XSGUqzRrTecOhJr7QAVgH0Z4ihvHMlKrG0d7r/oKAKE14cTmcoGBsw0kjDEa/wQAP2QRzyVea3kZTvDeJzCn2yuwYJhvwpmLOflX7frApQo4xrQRW9ke9EOC7UKAu/ML7MdORhfkhjTMJ5/QHWjKGaRXP6rfsH9R6PZdVAb+qFg2oY0YyUApJxW4ICJg4UplFHWjy1SNvJEbDx6BLxsAtfcwZo1bFm3Ils8qGWjwJHGj3rkbouYEm8/HFFO81L2IbXkH3YRa6ESL8pp8t6XTCQiJyRqubnaXyh9ffzN+CzeCw== 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=0m4GltoMJGWSDzBgnpJjJhYkpG9UyEwyGQ0vd8Aj+P0=; b=faaoczYt4uLRbEbHMdQZDJclhUoXIbhfR5VyWxTiJcxRPfiK6EwlQj38vKR29QWNP1BrHxKS8mmqiT/ZTcGgODLaHKtBBxduukdWK+Xow1JdD3vzGnByBAS6buutLoXgr5fcrHX5xEB72Jg5gGh3FCrHcHJGwW+1cpjmPbXmDNUd08bzdlAnu3Dr24YvAUviwJ87YdlxXBM7takpGel+h9vZmxqvsrNOqk6ycx9G90hk/ci0YHxXnb79JmWRTRHZpgzcBNjYG931PsIMxYyAn+bArutnWwa/CCQRdBfTsp8L5Yr6JOGscuNFUgsiIaub198czTCntUd4Pz2N3+w5qg== 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=0m4GltoMJGWSDzBgnpJjJhYkpG9UyEwyGQ0vd8Aj+P0=; b=Cg2Bdkrv7aB6DNm9GGIOfF3W0J4870xaKZ3OWLrhIa3ksTv6DI6u1wZyJEc9QacHgqC9vAfpWeNGiRizKg8cYroFrb68EcMIH5JYVEHqo59TtvnYTm2GoWLZK45XEOluZeAjyK9jlXfGZvVtih5jH3vDHierUsGTkPa2MfPgkNQ= 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 DM4PR12MB5723.namprd12.prod.outlook.com (2603:10b6:8:5e::9) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7962.19; Thu, 12 Sep 2024 13:37:40 +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 13:37:39 +0000 Message-ID: Date: Thu, 12 Sep 2024 14:37:35 +0100 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v3] doc: add new driver guidelines To: Nandini Persad Cc: "dev@dpdk.org" , Thomas Mojalon , Stephen Hemminger References: <20240814190901.14912-1-stephen@networkplumber.org> <20240910145801.46186-1-nandinipersad361@gmail.com> <85f2e676-046b-4f2d-8c31-d0a5532fda6e@amd.com> <1f0665f9-4fed-4880-bbea-51781a2d9710@amd.com> 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: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-ClientProxiedBy: DU7P191CA0012.EURP191.PROD.OUTLOOK.COM (2603:10a6:10:54e::23) To CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR12MB4294:EE_|DM4PR12MB5723:EE_ X-MS-Office365-Filtering-Correlation-Id: 127bf882-b89f-41b6-252c-08dcd3301216 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?SXNpZXVyM0dpL2JvOUpJSmZROE1keDVFRkxMakNJOTdaZlE5ZHJrMWhTeHVT?= =?utf-8?B?ZElvVXlReHUvSVgzaVRrakFMbC83bU1TWnBqNWtudXdXTDg5KzVodjlHQ2xY?= =?utf-8?B?eGlFRUdQcjhCeGRuZUE5Q09ETDdvcjNRMm9zV1FkdVNNald5SFJKWmpDRHJC?= =?utf-8?B?V25iRmhmT0xVbDFoK1JPcmErM0ZvTmhRMkp6SWhpeXRyWnFmMG9PSFFyWnNJ?= =?utf-8?B?RUpyVTBRKzZXVTB3RXRHempOSVhPS0pFNVFScklNd0hFbTB2aWVCMlNWY2tG?= =?utf-8?B?QmFVTjdGUzBISFAzK21mMTJMZGlZSkp2ZGhYTVF2WnQ5KzFyREE3ZnpzR2FB?= =?utf-8?B?eXE5ZjdjcDRuamhLMUI5QlNmZkJZSlJvTzliV0Zsd2F4YzQyejArWFd0bWVz?= =?utf-8?B?K29YTjh6WFk0UlR4NGdEZUxveVdDOVpRVWlSY3hmNDdyNTl3RnF3TW44RnQx?= =?utf-8?B?Yit3dzdmZS9VT2dKKzBmSkh6c1ZBNXloWFp1bi9uNWVsang4WHNyZlk0WkJO?= =?utf-8?B?RFNUNWw0aTM1YzlxSmpBOW1HU3JYSUdNS1F2WjFaU0lmQWYvU01zcWNBTmNr?= =?utf-8?B?ZFpZRVRoT0Z2bUFKNjFOekdHaDlDM0NsTzh3bUtjbkUzWjF5eEhwSzZDU3pL?= =?utf-8?B?eGo5ck5xR0FseFIxTjJRWVZ0VmFCK0ppNDVVckxiNFRIM01qcVF0ZXlIOHZV?= =?utf-8?B?RXlTLzNNSmFFLzJXUFYzZ2phcFVyNWFVK2ppc1RkcGNoZWRLL3IvdnUybVhJ?= =?utf-8?B?OTdHaHBnMHdKNUMwdkt4N3ZnWWhxSnBKMGRvTGJINFpDd3I0OUtTSmdncUFG?= =?utf-8?B?aGVVZ2lKNVdCVUxPdXl6SmpGdFJrazBHMnk2bnlZNUhFWVVSaFpCL0NBblhN?= =?utf-8?B?WXA2dnJkbUFPU1hFSGsrOVRsWmRLaGt6WkJuWUdYN0xtVFljQkpFL0lGd25C?= =?utf-8?B?d05QZHFrMk5Wbld2M093SlRKakNMRlhzaWJBdFd4Y3NqUUQ1YzNSNXNmeGND?= =?utf-8?B?Mk9tc2srMU5aQ01kcFZZOGRTL2g0alhyRW9RbFpxbDg0NXlNVGd5S0dic1FQ?= =?utf-8?B?VlBxQzB4YWdUb0ZyUXllMTQ3anR5UGFPVWZxcDM4emJpdU42aVh2aytmU24w?= =?utf-8?B?UjNSUUpzK0ZIL3d5ckpYckVzWXEyMXpIcEdzNXVUOG9VM3duVFJZR0wweFFx?= =?utf-8?B?VTAvTFZIUlBuajEyU2NpYk5MdHRQcjU1RjJyUzlweStFK1hmSGt5cnBaV3NW?= =?utf-8?B?UW9HbVlEN0VBT2w5ZlVySnVPVTZEdXlHdXhRNmpVS2hqek5RYlFmZ2hLS0w0?= =?utf-8?B?QVo1Sy8zeHk2ZUcrWVRzT0tVMlRhNlZVbVpWdjYrUi9odjN4RnlHMlFsdFhi?= =?utf-8?B?TXZuT1BzYUsrblZ6U3c0bFlwY2d5UVVGTDMvbWF1dnF5NjM3RGtXUllmdWI3?= =?utf-8?B?M1RBTWVZMEhzR2lMdjAyTHJLZVBWd0h2NHBVbUNJWXV5ckM3VVdSemNjKzRV?= =?utf-8?B?WnJlNzgzZkNESHhReFJvK3IwV0pwd3Y2eFc5eXNtSGVwL0tpRENHZFBrUDdm?= =?utf-8?B?NGt2Y3ZQRjA0bmFsNFoxS3dwQnJqVzVoV2xJa0hUbG9aeERoa0ZHTU42N1lx?= =?utf-8?B?U1dURWhSSkhuYy9SYy9Hc3VCanN5MzI1bFFnODFPVjZLclVyWjV5cE9PM0Er?= =?utf-8?B?WmtIdFZvd01IM2lveEo0TjJHV0Y4c1pVSHhrZXlaa0pvdmUvL1lYbUJ3OHZI?= =?utf-8?B?WS9aWXpvMnZHWGlLMEZFVmh6V0ttWHFGUkp6YitUazF5ZmVHK2VmbTk5NjMx?= =?utf-8?B?V0xIUUY3aDgvQlFET2w0Zz09?= 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)(366016)(1800799024)(376014); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?TEpvOXprbXFmaTRBMktBdUtFelFvWmRnd3B4Myt3cVRyRmJhVlkrcmYyWGZz?= =?utf-8?B?V1BuOGQ3dGV3Q3BzTHMyVm95blpXWE5NR2RkVnNNT3NINyt2R1hEQ05OMkN1?= =?utf-8?B?VjR6K0xWeUlzbDJjajhlR2hPaXFSb3dXVTg0T1RNemFQVW5zYTY0eEgwYmJN?= =?utf-8?B?NDF5Vk9SL3NzbldHRkRqeW5PSXJNcGtueWxJTUo0RFA2YkViMFRwaDBXZDBy?= =?utf-8?B?ZS9lYm1GcC9MNWJXRXJQMkxnRDM1N0JWTjRIOHd1YTQ5VzRSdFFqRjlrNGhN?= =?utf-8?B?eGRlUGpZVjh1bmhQZmpOZXN1RTQ0MmVxSHpNaTg5cWxVQ1M2M0RGZkFZRUky?= =?utf-8?B?U0FTbUJIR05xNWRIS3IxL1NjdDk0TFJ0NVQraFB6T0VicVN1aHZlUkY3SEoy?= =?utf-8?B?ekRIRytGclNXUUpzK0dMQWR5K2xQeXRsY0x4a0VKM2JUK0JrZEZzdm1qSkI2?= =?utf-8?B?eEhKWFhGaDlHdkIyRDFzc2tkeEYwRjhFTVEzcDdlWFQvWmRDNWcxVGNIbmsx?= =?utf-8?B?ZVNjdmRDWE9jblRFUytCejl0WHRzcXBqYjREcjBTdHdmQWRoQzJOMmZ1czVX?= =?utf-8?B?VTNTcWlvaWV2YW05NTd5a2Q1NDdEbTFZMVNqMmNsQjhLRzFLWis1RmFmRlpY?= =?utf-8?B?emdnbDFEUmszS2tHZWdKNDI5cTBkVVZFckVXQlV1Vm1VejFvTTZFY1hVQ1dj?= =?utf-8?B?aDBCSHNRQU5QRTYrNmk5SHI2aS9TOUYzQmdpdVNieDJqTW5HdVdJZGVhaEll?= =?utf-8?B?TGYvV29uZlNQd1dKR0p4Qk81TzFqWGJUbnZIcGVGbEJleDJ4THZreXlhSzRw?= =?utf-8?B?T0xhZkNjVm9vTnVhL09HRk9LODJyL2NoRjFScHlDTVc2LzVrVnZvN1Jxd1c2?= =?utf-8?B?YVNVT1Zrc1F4VXRodGJMMm00Y1lTWXlHUHhkcEVFU2UvVzZ3VWgzYUhNMW0w?= =?utf-8?B?WlBuZTRDRG1oSmkrYXdTSVpsTUp5SjdVM2JYdkdIcFd6ZVA2NUJZSkVxQVNR?= =?utf-8?B?U3E0bklsMkYzdmZhaVN0Q2FqZ2NuRktqMHUzWFVIakh2KzFscElUTk53bFg3?= =?utf-8?B?NjQrQ0xsM0FPOURlUk5VWE5yMEJwaGZPYmdMNkY0WHYvWWxtSkY3dEVsdzA0?= =?utf-8?B?Szk0alJmVWhPRmJMYWgrbm9hdkhOak9DWFVDVDdCUmVrRDVkbVJza2VHRXlS?= =?utf-8?B?ajZQR3BFZm5hNGFCVk1Cbjg0enFIa2w0b2NwcGx6MzRObXpXZyt1ckh3U1Yr?= =?utf-8?B?WS9ja3NlUjhmaHBkSmJMQmxyWVRuV0RPcERsTDJ4eENyUzl5UzN5TVpML25h?= =?utf-8?B?ejV2b1g4L3h6TzBsS0dETThJTHd6ZVNrcWFWQklHekt5blpZRlluNHQ1Qzlv?= =?utf-8?B?N0dOOVNCaEdOQXJkR3lQVC9LOEhPQzczTy92dHVFWmZlQmhVUFBIZHlzMWZJ?= =?utf-8?B?QUxyaksvNHB3U2lNR2ZEcEs3YjNNVFNSZVRzZkl0NTRIN2w4TVh3SEM1ZHhY?= =?utf-8?B?ZW44Ry85WTJsV3d2UnNzeFBzWXIrWlBJSW5NbzdOUm9NUzY1b05qMkJHRWpP?= =?utf-8?B?d0FpVmxPR3FER0RPK1IrY0ZhVkJjZVQ1MTd3MHZnVWozZlJ3T21NSjJ2Y1FJ?= =?utf-8?B?OUxvMXdqZ21BSXhCZWV2S2VjNmwvcHZTYmNQeGltcStOeENuenlKV0Q4MWtF?= =?utf-8?B?SWhFUzJTMEt6SUo5RldFWE90RDgzWXhZdUdTQkVKRW0zN1cxMFdQc1lYV3BO?= =?utf-8?B?V21tWmsvd2pDTGtpaURac2JOT28vRHcwSms5MCtpSm05Vk1uVmpFdU9JWmY0?= =?utf-8?B?amRLWjhxOXV3UHkxd1dmNEkyQW9CTjhCeXZWVm1mejhlZXJ3ZzhoOHcvUU1Z?= =?utf-8?B?MVoyOEVvL2s4OUQxcENpWlROMFpqRklxbjN4dXdnSzBkYnFqWWhIRjQ1RTFH?= =?utf-8?B?bFpLK1Vjd3NXN0JBeXgwcXRJYWxwM3h2VkgvZ2o2WDZRYUtDTjVINThxSlF1?= =?utf-8?B?ZGs0NnN1UWJMSFgrZFZlZjFWTHF5aWN3N3JLbnFuYmkvak40T2dPb3NOZXls?= =?utf-8?B?dktDQ1UzTWJ0UTBkaW0rM21jS2J5Y2trdm9QdEFGaFRIUGNNNjduTlQ0TS8x?= =?utf-8?Q?1oHZ01d846B76+C9cK7C5nIBC?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: 127bf882-b89f-41b6-252c-08dcd3301216 X-MS-Exchange-CrossTenant-AuthSource: CH2PR12MB4294.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Sep 2024 13:37:39.7254 (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: MBS9UXBZGxkmqR7zTWEG03AyPiVg0VD9VGJ8ZCKlpZY4VClMEBxt1UkXQ4oquIQz X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM4PR12MB5723 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/12/2024 2:18 PM, Nandini Persad wrote: > I like the separation. I can include it in V4 and see, it would be > helpful to know if it’s more or less confusing that way.  > > For the prompt before each list, can we say something like “Avoid doing > the following” and “Suggested actions” or something a little better > grammatically. We could also just say “Avoid”.   > Agree to have better header for the lists, what about: "Avoid doing the following" and "Remember to do the following" Or we can go with whatever you think more convenient. > ------------------------------------------------------------------------ > *From:* Ferruh Yigit > *Sent:* Thursday, September 12, 2024 1:13:33 AM > *To:* Nandini Persad > *Cc:* dev@dpdk.org ; Thomas Mojalon ; > Stephen Hemminger > *Subject:* Re: [PATCH v3] doc: add new driver guidelines >   > 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 > >> 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. >> >