From: Ferruh Yigit <ferruh.yigit@amd.com>
To: Stephen Hemminger <stephen@networkplumber.org>, dev@dpdk.org
Cc: Nandini Persad <nandinipersad361@gmail.com>,
Thomas Monjalon <thomas@monjalon.net>,
Chengwen Feng <fengchengwen@huawei.com>
Subject: Re: [PATCH v4] doc: add new driver guidelines
Date: Fri, 27 Sep 2024 01:19:15 +0100 [thread overview]
Message-ID: <37667f4b-1730-4006-b084-6c32e85979f3@amd.com> (raw)
In-Reply-To: <20240916162856.11566-1-stephen@networkplumber.org>
On 9/16/2024 5:28 PM, Stephen Hemminger wrote:
> From: Nandini Persad <nandinipersad361@gmail.com>
>
> 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 <ferruh.yigit@amd.com>
> Co-authored-by: Thomas Monjalon <thomas@monjalon.net>
> Signed-off-by: Nandini Persad <nandinipersad361@gmail.com>
> Reviewed-by: Stephen Hemminger <stephen@networkplumber.org>
> Acked-by: Chengwen Feng <fengchengwen@huawei.com>
>
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
next prev parent reply other threads:[~2024-09-27 0:19 UTC|newest]
Thread overview: 24+ 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
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 [this message]
2024-09-27 15:02 ` 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=37667f4b-1730-4006-b084-6c32e85979f3@amd.com \
--to=ferruh.yigit@amd.com \
--cc=dev@dpdk.org \
--cc=fengchengwen@huawei.com \
--cc=nandinipersad361@gmail.com \
--cc=stephen@networkplumber.org \
--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).