From: Hemant Agrawal <hemant.agrawal@nxp.com>
To: "jerinj@marvell.com" <jerinj@marvell.com>, "dev@dpdk.org" <dev@dpdk.org>
Cc: "techboard@dpdk.org" <techboard@dpdk.org>,
Thomas Monjalon <thomas@monjalon.net>
Subject: RE: [dpdk-dev] [v5] doc: define qualification criteria for external library
Date: Mon, 8 Jan 2024 08:17:19 +0000 [thread overview]
Message-ID: <PAXPR04MB9328FD51A0A58B6342B82A5F896B2@PAXPR04MB9328.eurprd04.prod.outlook.com> (raw)
In-Reply-To: <20240108075850.4151361-1-jerinj@marvell.com>
[-- Attachment #1: Type: text/plain, Size: 3998 bytes --]
On 08-Jan-24 1:28 PM, jerinj@marvell.com wrote:
> From: Jerin Jacob <jerinj@marvell.com>
>
> Define qualification criteria for external library
> based on a techboard meeting minutes [1] and past
> learnings from mailing list discussion.
>
> [1]
> http://mails.dpdk.org/archives/dev/2019-June/135847.html
> https://mails.dpdk.org/archives/dev/2024-January/284849.html
>
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> Acked-by: Thomas Monjalon <thomas@monjalon.net>
> ---
> doc/guides/contributing/index.rst | 1 +
> .../contributing/library_dependency.rst | 52 +++++++++++++++++++
> 2 files changed, 53 insertions(+)
> create mode 100644 doc/guides/contributing/library_dependency.rst
>
> v5:
> - Added "Dependency nature" section based on Stephen's input
>
> v4:
> - Address Thomas comments from
https://patches.dpdk.org/project/dpdk/patch/20240105121215.3950532-1-jerinj@
marvell.com/
>
> v3:
> - Updated the content based on TB discussion which is documented at
> https://mails.dpdk.org/archives/dev/2024-January/284849.html
>
> v2:
> - Added "Meson build integration" and "Code readability" sections.
>
>
> diff --git a/doc/guides/contributing/index.rst
b/doc/guides/contributing/index.rst
> index dcb9b1fbf0..e5a8c2b0a3 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
> + library_dependency
> patches
> vulnerability
> stable
> diff --git a/doc/guides/contributing/library_dependency.rst
b/doc/guides/contributing/library_dependency.rst
> new file mode 100644
> index 0000000000..94025fdf60
> --- /dev/null
> +++ b/doc/guides/contributing/library_dependency.rst
> @@ -0,0 +1,52 @@
> +.. SPDX-License-Identifier: BSD-3-Clause
> + Copyright(c) 2024 Marvell.
> +
> +External Library dependency
> +===========================
> +
> +This document defines the qualification criteria for external libraries
that may be
> +used as dependencies in DPDK drivers or libraries.
> +
> +#. **Documentation:**
> +
> + - Must have adequate documentation for the steps to build it.
> + - Must have clear license documentation on distribution and usage
aspects of external library.
> +
> +#. **Free availability:**
> +
> + - The library must be freely available to build in either source or
binary form.
> + - It shall be downloadable from a direct link. There shall not be any
requirement to explicitly
> + login or sign a user agreement.
> +
> +#. **Usage License:**
> +
> + - Both permissive (e.g., BSD-3 or Apache) and non-permissive (e.g.,
GPLv3) licenses are acceptable.
> + - In the case of a permissive license, automatic inclusion in the
build process is assumed.
> + For non-permissive licenses, an additional build configuration
option is required.
> +
> +#. **Distributions License:**
> +
> + - No specific constraints beyond documentation.
Though we are not mandatory open distribution. However we should ask for the
defining the distribution aspect clearly in the library.
>
> +
> +#. **Compiler compatibility:**
> +
> + - The library must be able to compile with a DPDK supported compiler
for the given execution
> + environment.
> + For example, for Linux, the library must be able to compile with GCC
and/or clang.
> + - Library may be limited to a specific OS.
> +
> +#. **Meson build integration:**
> +
> + - The library must have standard method like ``pkg-config`` for
seamless integration with
> + DPDK's build environment.
> +
> +#. **Code readability:**
> +
> + - Optional dependencies should use stubs to minimize ``ifdef``
clutter, promoting improved
> + code readability.
> +
> +#. **Dependency nature:**
> +
> + - The external library dependency should be optional.
> + i.e Missing external library must not impact the core functionality
of the DPDK, specific
> + library and/or driver will not built if dependencies are not meet.
[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 9818 bytes --]
next prev parent reply other threads:[~2024-01-08 8:17 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-28 5:16 [dpdk-dev] [PATCH] " jerinj
2023-09-28 5:40 ` [dpdk-dev] [PATCH v2] " jerinj
2023-11-17 4:33 ` Jerin Jacob
2023-11-17 8:27 ` Morten Brørup
2023-11-17 9:52 ` Bruce Richardson
2023-11-17 10:57 ` Morten Brørup
2023-11-19 7:07 ` Jerin Jacob
2023-11-19 8:53 ` Morten Brørup
2023-11-20 17:46 ` Jerin Jacob
2023-11-27 16:25 ` Thomas Monjalon
2023-11-27 17:13 ` Stephen Hemminger
2024-01-05 12:12 ` [dpdk-dev] [v3] " jerinj
2024-01-05 12:24 ` Thomas Monjalon
2024-01-05 12:30 ` [dpdk-dev] [v4] " jerinj
2024-01-08 7:58 ` [dpdk-dev] [v5] " jerinj
2024-01-08 8:17 ` Hemant Agrawal [this message]
2024-01-08 8:31 ` Jerin Jacob
2024-01-08 13:27 ` Hemant Agrawal
2024-01-09 13:41 ` Jerin Jacob
2024-01-08 17:18 ` Stephen Hemminger
2024-01-08 19:55 ` Morten Brørup
2024-01-09 13:42 ` Jerin Jacob
2024-01-08 9:25 ` Morten Brørup
2024-01-09 14:01 ` Jerin Jacob
2024-01-09 14:10 ` [dpdk-dev] [v6] " jerinj
2024-03-19 3:32 ` Jerin Jacob
2024-03-19 5:08 ` Hemant Agrawal
2024-03-19 11:59 ` Ferruh Yigit
2024-01-05 17:27 ` [dpdk-dev] [v3] " Stephen Hemminger
2024-01-08 7:53 ` Jerin Jacob
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=PAXPR04MB9328FD51A0A58B6342B82A5F896B2@PAXPR04MB9328.eurprd04.prod.outlook.com \
--to=hemant.agrawal@nxp.com \
--cc=dev@dpdk.org \
--cc=jerinj@marvell.com \
--cc=techboard@dpdk.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).