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 1104E45A45; Fri, 27 Sep 2024 17:02:20 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 458B44025D; Fri, 27 Sep 2024 17:02:19 +0200 (CEST) Received: from fout-a1-smtp.messagingengine.com (fout-a1-smtp.messagingengine.com [103.168.172.144]) by mails.dpdk.org (Postfix) with ESMTP id D576940156 for ; Fri, 27 Sep 2024 17:02:17 +0200 (CEST) Received: from phl-compute-08.internal (phl-compute-08.phl.internal [10.202.2.48]) by mailfout.phl.internal (Postfix) with ESMTP id 2D6021380201; Fri, 27 Sep 2024 11:02:17 -0400 (EDT) Received: from phl-mailfrontend-02 ([10.202.2.163]) by phl-compute-08.internal (MEProxy); Fri, 27 Sep 2024 11:02:17 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:cc:content-transfer-encoding:content-type:content-type:date :date:from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:subject:subject:to:to; s=fm2; t=1727449337; x=1727535737; bh=5OQnN9LSlJmNZSvS86mH8xlSY7CXfGv1XojpLKN1ugA=; b= SFPcO+rnEGc1WS8VukSaTmiQAzDdokHx/MZv1JO5zMUB5/iqmv1TMZefxu1QONOl Z0e2Ol3gfH7SYfkySPFfAN8mTrrxSB9UT4EAn975uqj23uHNvp+cMzoaHRG94DAY /EMjywZ19GSP4blLZQ2waxQhYB9aRk+BGhgrP66t69qRDCfbtr6vmPUfKo74pJ4M dhuZeBO2PACQIpuusm9P2RGVZvgpFpH6KgTdHuyoNh6aeF4Y0so56TW0IC3kWr7q S3Z1kXuCMDPVC9wBQFICSx8AT8WW1ioycgOLz0hGnxDCuB1fjMXUtuYwODbJGvbe 1clPI0OFRUW2W16r76YO1w== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:content-type:date:date:feedback-id:feedback-id :from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t=1727449337; x= 1727535737; bh=5OQnN9LSlJmNZSvS86mH8xlSY7CXfGv1XojpLKN1ugA=; b=O v2CxduWWRMndegObkbpUttPZWlgd928/JM88KlmvNgoULv/8npTzxzmZ82l3XsR0 4L3fNooEr8kEdHSFT44DwAa4suegtWmBMXXXJOo3+QFZfBWmZKosW5bS9R1ZkbsR EDaI6+b/5AeqgZA8KWIEasgsSibpUA6nYvgiPQ6sxOLbayUZe9fUoHxB6xmoB6Iv lYwnopYQKQXskbCofcyS0p541wA42YUcxpUSt0qbrXMaufE5KNFqTjso8Z33s8vE jFL+E3H2lVOjFgPVkC2ryQixWBrb+I8eV8iMl8y5n4YJMUqGIFfRxPBs4pTXHAl2 HF8CMEwam0kUX55sattCw== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrvddtledgkeefucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdggtfgfnhhsuhgsshgtrhhisggvpdfu rfetoffkrfgpnffqhgenuceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnh htshculddquddttddmnecujfgurhephffvvefufffkjghfggfgtgesthfuredttddtjeen ucfhrhhomhepvfhhohhmrghsucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrg hlohhnrdhnvghtqeenucggtffrrghtthgvrhhnpeejudevheeiveduuddtveffgfdtgeek ueevjeffjeegtdeggeekgfdvuefgfeekjeenucevlhhushhtvghrufhiiigvpedtnecurf grrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtpdhn sggprhgtphhtthhopeehpdhmohguvgepshhmthhpohhuthdprhgtphhtthhopehsthgvph hhvghnsehnvghtfihorhhkphhluhhmsggvrhdrohhrghdprhgtphhtthhopehfvghrrhhu hhdrhihighhithesrghmugdrtghomhdprhgtphhtthhopehnrghnughinhhiphgvrhhsrg gufeeiudesghhmrghilhdrtghomhdprhgtphhtthhopeguvghvseguphgukhdrohhrghdp rhgtphhtthhopehfvghnghgthhgvnhhgfigvnheshhhurgifvghirdgtohhm X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Fri, 27 Sep 2024 11:02:13 -0400 (EDT) From: Thomas Monjalon To: Stephen Hemminger , Ferruh Yigit , Nandini Persad Cc: dev@dpdk.org, Chengwen Feng Subject: Re: [PATCH v4] doc: add new driver guidelines Date: Fri, 27 Sep 2024 17:02:07 +0200 Message-ID: <2749844.mvXUDI8C0e@thomas> In-Reply-To: <37667f4b-1730-4006-b084-6c32e85979f3@amd.com> References: <20240813201250.9383-1-nandinipersad361@gmail.com> <20240916162856.11566-1-stephen@networkplumber.org> <37667f4b-1730-4006-b084-6c32e85979f3@amd.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="utf-8" 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 27/09/2024 02:19, Ferruh Yigit: > On 9/16/2024 5:28 PM, Stephen Hemminger wrote: > > From: Nandini Persad > > +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. I prefer talking about public API from the driver, it's clear. Note that an API is for the Application, so it's always public :) but better to make it explicit.