From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 118E34383C;
Fri, 5 Jan 2024 13:30:53 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 90474402EE;
Fri, 5 Jan 2024 13:30:52 +0100 (CET)
Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com
[67.231.156.173])
by mails.dpdk.org (Postfix) with ESMTP id 866044027C;
Fri, 5 Jan 2024 13:30:50 +0100 (CET)
Received: from pps.filterd (m0045851.ppops.net [127.0.0.1])
by mx0b-0016f401.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id
4054apKv003544; Fri, 5 Jan 2024 04:30:49 -0800
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=
from:to:cc:subject:date:message-id:in-reply-to:references
:mime-version:content-transfer-encoding:content-type; s=
pfpt0220; bh=MWfhCippmWGc5GKCZ84173gS7CbhqyXi5ZKTfvMc62k=; b=iqz
uiZ20xyh6Tuv196w8irROokhv3syo/pMa016qlbH8ZGnXS3vihFnapcNUJTZq8pe
4/HEZEbiryMD3NVr50Q3fAQ2xeOZYiMfg95TIMtcUbGUCU/9gUTzhVWUJgaC3SD3
4kSyoH9kjOR799TWUZtetZm7VePcwT7R4d+zZTErhB3sw9u0hHvCnrl/acWgBvu1
8kvdCvge32NaD7pX9UVN2XpPGjk0lzFLBmaxE+zZ7JmvAAPHxOoO9MBXy7TIeK2W
3jR7AMGXW9vNsBakkNqVgeZQ2H5oRpe8L+5TERYPIdcWWNR/YrGRoQLPGm53yTpa
DuPxDSpVLkJb2Gqmx7g==
Received: from dc5-exch02.marvell.com ([199.233.59.182])
by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 3veaw01679-1
(version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT);
Fri, 05 Jan 2024 04:30:49 -0800 (PST)
Received: from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH02.marvell.com
(10.69.176.39) with Microsoft SMTP Server (TLS) id 15.0.1497.48;
Fri, 5 Jan 2024 04:30:47 -0800
Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com
(10.69.176.39) with Microsoft SMTP Server id 15.0.1497.48 via Frontend
Transport; Fri, 5 Jan 2024 04:30:47 -0800
Received: from jerin-lab.marvell.com (jerin-lab.marvell.com [10.28.34.14])
by maili.marvell.com (Postfix) with ESMTP id 107233F7070;
Fri, 5 Jan 2024 04:30:45 -0800 (PST)
From: <jerinj@marvell.com>
To: <dev@dpdk.org>
CC: <techboard@dpdk.org>, Jerin Jacob <jerinj@marvell.com>, Thomas Monjalon
<thomas@monjalon.net>
Subject: [dpdk-dev] [v4] doc: define qualification criteria for external
library
Date: Fri, 5 Jan 2024 18:00:42 +0530
Message-ID: <20240105123042.4007877-1-jerinj@marvell.com>
X-Mailer: git-send-email 2.43.0
In-Reply-To: <20240105121215.3950532-1-jerinj@marvell.com>
References: <20240105121215.3950532-1-jerinj@marvell.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-Proofpoint-GUID: HlMimiFpvNCoSgcb-UQNkT_4tae5OLo9
X-Proofpoint-ORIG-GUID: HlMimiFpvNCoSgcb-UQNkT_4tae5OLo9
X-Proofpoint-Virus-Version: vendor=baseguard
engine=ICAP:2.0.272,Aquarius:18.0.997,Hydra:6.0.619,FMLib:17.11.176.26
definitions=2023-12-09_02,2023-12-07_01,2023-05-22_02
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
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 | 46 +++++++++++++++++++
2 files changed, 47 insertions(+)
create mode 100644 doc/guides/contributing/library_dependency.rst
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..367e380a89
--- /dev/null
+++ b/doc/guides/contributing/library_dependency.rst
@@ -0,0 +1,46 @@
+.. 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.
+
+#. **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.
--
2.43.0