From: Ferruh Yigit <ferruh.yigit@amd.com>
To: Nandini Persad <nandinipersad361@gmail.com>, dev@dpdk.org
Cc: Thomas Mojalon <thomas@monjalon.net>,
Chengwen Feng <fengChengwen@huawei.com>
Subject: Re: [PATCH v3] doc: add new driver guidelines
Date: Wed, 11 Sep 2024 01:16:26 +0100 [thread overview]
Message-ID: <85f2e676-046b-4f2d-8c31-d0a5532fda6e@amd.com> (raw)
In-Reply-To: <20240910145801.46186-1-nandinipersad361@gmail.com>
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.
next prev parent reply other threads:[~2024-09-11 0:16 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-13 20:12 [PATCH] " Nandini Persad
2024-08-14 2:35 ` [PATCH v2] " Stephen Hemminger
2024-08-14 10:10 ` David Marchand
2024-08-14 19:08 ` Stephen Hemminger
2024-09-05 9:16 ` [EXTERNAL] " Akhil Goyal
2024-09-05 9:49 ` Ferruh Yigit
2024-09-05 9:52 ` Akhil Goyal
2024-09-06 8:05 ` fengchengwen
2024-09-06 8:27 ` Ferruh Yigit
2024-09-09 1:01 ` fengchengwen
2024-09-10 14:58 ` [PATCH v3] " Nandini Persad
2024-09-11 0:16 ` Ferruh Yigit [this message]
2024-09-11 16:04 ` Nandini Persad
2024-09-12 8:13 ` Ferruh Yigit
2024-09-12 13:18 ` Nandini Persad
2024-09-12 13:37 ` Ferruh Yigit
2024-09-12 13:40 ` Nandini Persad
2024-09-12 20:26 ` Stephen Hemminger
2024-09-13 4:19 ` WanRenyong
2024-09-13 9:07 ` Ferruh Yigit
2024-09-13 16:08 ` Stephen Hemminger
2024-09-16 16:28 ` [PATCH v4] " Stephen Hemminger
2024-09-27 0:19 ` Ferruh Yigit
2024-09-27 15:02 ` Thomas Monjalon
2024-10-04 16:39 ` [PATCH v5] " Nandini Persad
2024-10-04 18:33 ` Ferruh Yigit
2024-10-06 18:42 ` [PATCH v6] " Nandini Persad
2024-10-06 21:09 ` Ferruh Yigit
2024-10-18 17:04 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=85f2e676-046b-4f2d-8c31-d0a5532fda6e@amd.com \
--to=ferruh.yigit@amd.com \
--cc=dev@dpdk.org \
--cc=fengChengwen@huawei.com \
--cc=nandinipersad361@gmail.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).