Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/135808/?format=api
{ "id": 135808, "url": "https://patches.dpdk.org/api/patches/135808/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20240109141009.497807-1-jerinj@marvell.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20240109141009.497807-1-jerinj@marvell.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240109141009.497807-1-jerinj@marvell.com", "date": "2024-01-09T14:10:09", "name": "[v6] doc: define qualification criteria for external library", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "47b74e9b52aa807e4b714608062abbea6e140a63", "submitter": { "id": 1188, "url": "https://patches.dpdk.org/api/people/1188/?format=api", "name": "Jerin Jacob Kollanukkaran", "email": "jerinj@marvell.com" }, "delegate": { "id": 1, "url": "https://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20240109141009.497807-1-jerinj@marvell.com/mbox/", "series": [ { "id": 30767, "url": "https://patches.dpdk.org/api/series/30767/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=30767", "date": "2024-01-09T14:10:09", "name": "[v6] doc: define qualification criteria for external library", "version": 6, "mbox": "https://patches.dpdk.org/series/30767/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/135808/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/135808/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "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])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 17B0443873;\n\tTue, 9 Jan 2024 15:10:31 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 57B524067A;\n\tTue, 9 Jan 2024 15:10:30 +0100 (CET)", "from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com\n [67.231.148.174])\n by mails.dpdk.org (Postfix) with ESMTP id 919864013F;\n Tue, 9 Jan 2024 15:10:28 +0100 (CET)", "from pps.filterd (m0045849.ppops.net [127.0.0.1])\n by mx0a-0016f401.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id\n 409BvaAw018241; Tue, 9 Jan 2024 06:10:27 -0800", "from dc5-exch01.marvell.com ([199.233.59.181])\n by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3vh5qt0edq-1\n (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT);\n Tue, 09 Jan 2024 06:10:26 -0800 (PST)", "from DC5-EXCH01.marvell.com (10.69.176.38) by DC5-EXCH01.marvell.com\n (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.48;\n Tue, 9 Jan 2024 06:10:25 -0800", "from maili.marvell.com (10.69.176.80) by DC5-EXCH01.marvell.com\n (10.69.176.38) with Microsoft SMTP Server id 15.0.1497.48 via Frontend\n Transport; Tue, 9 Jan 2024 06:10:25 -0800", "from jerin-lab.marvell.com (jerin-lab.marvell.com [10.28.34.14])\n by maili.marvell.com (Postfix) with ESMTP id 54ABD3F7055;\n Tue, 9 Jan 2024 06:10:23 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=\n from:to:cc:subject:date:message-id:in-reply-to:references\n :mime-version:content-transfer-encoding:content-type; s=\n pfpt0220; bh=HE5p04cjCSNz1Q3MFmwmvSKlHF9aCZ/kdE/yZSu9fUo=; b=S+d\n IewXvnjpk9qBjJ0ctD5S/vDpwX3hHcszSXsgBKMrPrWvUMyysHsE1ETPChiOB9xw\n 5/IoIRTgy/v6NoOiOimdEiOtMpMvF+xUC76Qj5EUeLCRWMTD8Vuq1eCxWzGUArnD\n mO2PZe5jTgx9hirWZpPI2ZH7pJLNeDtoCdr5gSMdbQyl8RlfGq6Zu73OaAKX6QKp\n 96SIxtqC9vu+a+qmkKIOC3vxzsEvrd8ocYzeM7QbxvZclfhqaqtZQ+uqfIfamNhL\n 53AlZT23DIvY3Nud0jz5C2tIeP15xaFwoSxCvk7vv25Z6X8aNEGrOlq7d3pDbXiy\n g+7RY/8pPw8l+qWoMIg==", "From": "<jerinj@marvell.com>", "To": "<dev@dpdk.org>", "CC": "<techboard@dpdk.org>, <govboard@dpdk.org>, Jerin Jacob\n <jerinj@marvell.com>, Thomas Monjalon <thomas@monjalon.net>", "Subject": "[dpdk-dev] [v6] doc: define qualification criteria for external\n library", "Date": "Tue, 9 Jan 2024 19:40:09 +0530", "Message-ID": "<20240109141009.497807-1-jerinj@marvell.com>", "X-Mailer": "git-send-email 2.43.0", "In-Reply-To": "<20240108075850.4151361-1-jerinj@marvell.com>", "References": "<20240108075850.4151361-1-jerinj@marvell.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Content-Type": "text/plain", "X-Proofpoint-ORIG-GUID": "F1sXU0O0x-frxN42319di4O23oYyZFtW", "X-Proofpoint-GUID": "F1sXU0O0x-frxN42319di4O23oYyZFtW", "X-Proofpoint-Virus-Version": "vendor=baseguard\n engine=ICAP:2.0.272,Aquarius:18.0.997,Hydra:6.0.619,FMLib:17.11.176.26\n 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>,\n <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>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "From: Jerin Jacob <jerinj@marvell.com>\n\nDefine qualification criteria for external library\nbased on a techboard meeting minutes [1] and past\nlearnings from mailing list discussion.\n\n[1]\nhttp://mails.dpdk.org/archives/dev/2019-June/135847.html\nhttps://mails.dpdk.org/archives/dev/2024-January/284849.html\n\nSigned-off-by: Jerin Jacob <jerinj@marvell.com>\nAcked-by: Thomas Monjalon <thomas@monjalon.net>\n---\n\nv6:\n- Address Morten's comments at https://mails.dpdk.org/archives/dev/2024-January/285029.html\n\nv5:\n- Added \"Dependency nature\" section based on Stephen's input\n\nv4:\n- Address Thomas comments from https://patches.dpdk.org/project/dpdk/patch/20240105121215.3950532-1-jerinj@marvell.com/\n\nv3:\n- Updated the content based on TB discussion which is documented at\nhttps://mails.dpdk.org/archives/dev/2024-January/284849.html\n\nv2:\n- Added \"Meson build integration\" and \"Code readability\" sections.\n\n doc/guides/contributing/index.rst | 1 +\n .../contributing/library_dependency.rst | 53 +++++++++++++++++++\n 2 files changed, 54 insertions(+)\n create mode 100644 doc/guides/contributing/library_dependency.rst", "diff": "diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst\nindex dcb9b1fbf0..e5a8c2b0a3 100644\n--- a/doc/guides/contributing/index.rst\n+++ b/doc/guides/contributing/index.rst\n@@ -15,6 +15,7 @@ Contributor's Guidelines\n documentation\n unit_test\n new_library\n+ library_dependency\n patches\n vulnerability\n stable\ndiff --git a/doc/guides/contributing/library_dependency.rst b/doc/guides/contributing/library_dependency.rst\nnew file mode 100644\nindex 0000000000..3b275f1c52\n--- /dev/null\n+++ b/doc/guides/contributing/library_dependency.rst\n@@ -0,0 +1,53 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2024 Marvell.\n+\n+External Library dependency\n+===========================\n+\n+This document defines the qualification criteria for external libraries that may be\n+used as dependencies in DPDK drivers or libraries.\n+The final decision to accept or reject is at the discretion of the DPDK Project's Technical Board.\n+\n+#. **Documentation:**\n+\n+ - Must have adequate documentation for the steps to build it.\n+ - Must have clear license documentation on distribution and usage aspects of external library.\n+\n+#. **Free availability:**\n+\n+ - The library must be freely available to build in either source or binary form.\n+ - It shall be downloadable from a direct link. There shall not be any requirement to explicitly\n+ login or sign a user agreement.\n+\n+#. **Usage License:**\n+\n+ - Both permissive (e.g., BSD-3 or Apache) and non-permissive (e.g., GPLv3) licenses are acceptable.\n+ - In the case of a permissive license, automatic inclusion in the build process is assumed.\n+ For non-permissive licenses, an additional build configuration option is required.\n+\n+#. **Distribution License:**\n+\n+ - No specific constraints, but clear documentation on distribution usage aspects is required.\n+\n+#. **Compiler compatibility:**\n+\n+ - The library must be able to compile with a DPDK supported compiler for the given target\n+ environment.\n+ For example, for Linux, the library must be able to compile with GCC and/or clang.\n+ - Library may be limited to a specific OS and/or specific hardware.\n+\n+#. **Meson build integration:**\n+\n+ - The library must have standard method like ``pkg-config`` for seamless integration with\n+ DPDK's build environment.\n+\n+#. **Code readability:**\n+\n+ - Optional dependencies should use stubs to minimize ``ifdef`` clutter, promoting improved\n+ code readability.\n+\n+#. **Dependency nature:**\n+\n+ - The external library dependency must be optional.\n+ i.e Missing external library must not impact the core functionality of the DPDK, specific\n+ library and/or driver will not be built if dependencies are not met.\n", "prefixes": [ "v6" ] }