From patchwork Thu Sep 28 05:40:35 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jerin Jacob X-Patchwork-Id: 132075 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 87CC24265B; Thu, 28 Sep 2023 07:40:48 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 145F7402AC; Thu, 28 Sep 2023 07:40:48 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by mails.dpdk.org (Postfix) with ESMTP id D82494027D; Thu, 28 Sep 2023 07:40:45 +0200 (CEST) Received: from pps.filterd (m0045851.ppops.net [127.0.0.1]) by mx0b-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 38RHOhZl012344; Wed, 27 Sep 2023 22:40:45 -0700 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=dLCaDUT82fur9+NQdBBEHJ1cBZLAintN9e9UJYYjzE4=; b=Vlgx6q2jgey/ObwhdYhxg8LGq7WthC79lCAbTZp7AiUkzqWh4VcfX//o+kzl/aD83Ybc qlTS8jh9KhHh7hc6GNeJueghdDKxIEjvaXEijaPja3XDASHljJb8fFL/ypytIzPOsjc9 IOnIoyiJiP9VbKyz+X7Io/i0re9+1kVSkFcWivb3gPAGCshJBuz3HRYnjxiEAKBYGBlh aKNg9PciJIIsZZ7lVI8UiPij1n/dc8fq12nwefeVaVG8QXGaLpg6jDAyq0soTu7bqD6/ hIzZ34RUSy0t77IbdKG6pitd01ognb2te9IKLODA+i4NC+ii4T5HhGGYAlIB4hj4Rut7 sA== Received: from dc5-exch02.marvell.com ([199.233.59.182]) by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 3tcrrs2484-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Wed, 27 Sep 2023 22:40:45 -0700 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; Wed, 27 Sep 2023 22:40:43 -0700 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; Wed, 27 Sep 2023 22:40:43 -0700 Received: from jerin-lab.marvell.com (jerin-lab.marvell.com [10.28.34.14]) by maili.marvell.com (Postfix) with ESMTP id 643205C68EE; Wed, 27 Sep 2023 22:40:41 -0700 (PDT) From: To: CC: , Jerin Jacob Subject: [dpdk-dev] [PATCH v2] doc: define qualification criteria for external library Date: Thu, 28 Sep 2023 11:10:35 +0530 Message-ID: <20230928054036.645183-1-jerinj@marvell.com> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20230928051648.562526-1-jerinj@marvell.com> References: <20230928051648.562526-1-jerinj@marvell.com> MIME-Version: 1.0 X-Proofpoint-ORIG-GUID: 9ooq6wJtXQ56sMVbJAj7Y7TesnpQNdXS X-Proofpoint-GUID: 9ooq6wJtXQ56sMVbJAj7Y7TesnpQNdXS X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.267,Aquarius:18.0.980,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2023-09-28_03,2023-09-27_01,2023-05-22_02 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 From: Jerin Jacob 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 Signed-off-by: Jerin Jacob --- v2: - Added "Meson build integration" and "Code readability" sections. doc/guides/contributing/index.rst | 1 + .../contributing/library_dependency.rst | 23 +++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 doc/guides/contributing/library_dependency.rst 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..687a3b6cef --- /dev/null +++ b/doc/guides/contributing/library_dependency.rst @@ -0,0 +1,23 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2023 Marvell. + +Library dependency +================== + +This document defines the qualification criteria for external libraries that may be +used as dependencies in DPDK drivers or libraries. + +- **Free availability**: The library must be freely available to build in either source or binary + form, with a preference for source form. + +- **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. + +- **Documentation**: Must have adequate documentation for the steps to build it. + +- **Meson build integration**: The library must have standard method like ``pkg-config`` + for seamless integration with DPDK's build environment. + +- **Code readability**: When the depended library is optional, use stubs to reduce the ``ifdef`` + clutter to enable better code readability.