From patchwork Thu May 18 13:21:39 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jerin Jacob X-Patchwork-Id: 126993 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 0B2DB42B3A; Thu, 18 May 2023 15:22:01 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AA47A40E25; Thu, 18 May 2023 15:22:00 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by mails.dpdk.org (Postfix) with ESMTP id 9540C4014F; Thu, 18 May 2023 15:21:59 +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 34IDHo7w004789; Thu, 18 May 2023 06:21:57 -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=oJ5753XInCunfV8RkWUe02AwlZd1ZIW44V+XkWUQigs=; b=lMHyHXfmiDl0gw0ah1/DWu1dYIFPu8vSXabI9Pc0mH7Pp/pYwxJZhDIiOCKV0JCutECh x1JzRfTYSBFupdgHBcUZOH8cQ43xHMIYg7piqMDR0LiRlJP9RB8OlgiQ6LzTYbwLsi7t DugRqXZvRf80ZDvMs32VQN7dlw6MNYX77cZVa/9fdK2+FkPczT4T0r+k727KdYzPrkzk +zNlZvKGJTzaB7a86AZ3tefssXobzaSkZDwn0YleLwt3chswu0/IsNn5MYc4Yr0yzz/f PMx42JFEoqSHJuc+X9dYM6cYy40xDSCkIE/vwhGScqps/qPHtBJRgUoxb5TyZ8Vv/XmJ Dw== Received: from dc5-exch01.marvell.com ([199.233.59.181]) by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 3qmyexc5dm-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Thu, 18 May 2023 06:21:57 -0700 Received: from DC5-EXCH01.marvell.com (10.69.176.38) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.48; Thu, 18 May 2023 06:21:55 -0700 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server id 15.0.1497.48 via Frontend Transport; Thu, 18 May 2023 06:21:54 -0700 Received: from jerin-lab.marvell.com (jerin-lab.marvell.com [10.28.34.14]) by maili.marvell.com (Postfix) with ESMTP id 227875B693B; Thu, 18 May 2023 06:21:48 -0700 (PDT) From: To: CC: , , , , Jerin Jacob Subject: [dpdk-dev] [PATCH v1] doc: process for new library approval in principle Date: Thu, 18 May 2023 18:51:39 +0530 Message-ID: <20230518132139.1350234-1-jerinj@marvell.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230213092616.3589932-1-jerinj@marvell.com> References: <20230213092616.3589932-1-jerinj@marvell.com> MIME-Version: 1.0 X-Proofpoint-GUID: dluQHK0F8pJmhXZbXJtNwwoE8b4TKGrG X-Proofpoint-ORIG-GUID: dluQHK0F8pJmhXZbXJtNwwoE8b4TKGrG X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.254,Aquarius:18.0.957,Hydra:6.0.573,FMLib:17.11.170.22 definitions=2023-05-18_10,2023-05-17_02,2023-02-09_01 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 Based on techboard meeting[1] action item, defining the process for a new library approval in principle. [1] https://mails.dpdk.org/archives/dev/2023-January/260035.html Signed-off-by: Jerin Jacob Acked-by: Ferruh Yigit --- RFC..v1: - Fix the review comments by Konstantin, Keven, Thomas at http://patches.dpdk.org/project/dpdk/patch/20230213092616.3589932-1-jerinj@marvell.com/ doc/guides/contributing/index.rst | 1 + doc/guides/contributing/new_library.rst | 48 +++++++++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 doc/guides/contributing/new_library.rst diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst index 7a9e6b368e..ef627329f1 100644 --- a/doc/guides/contributing/index.rst +++ b/doc/guides/contributing/index.rst @@ -18,3 +18,4 @@ Contributor's Guidelines vulnerability stable cheatsheet + new_library diff --git a/doc/guides/contributing/new_library.rst b/doc/guides/contributing/new_library.rst new file mode 100644 index 0000000000..7dde8cbe64 --- /dev/null +++ b/doc/guides/contributing/new_library.rst @@ -0,0 +1,48 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2023 Marvell. + +Process for new library approval in principle +============================================= + +Rationale +--------- + +Adding a new library to DPDK with proper RFC and then full patch-sets is significant work. +In order to save effort, developers will get an early approval in principle, or early feedback in +case the library is not suitable for various reasons. + +Process +------- + +#. When a contributor would like to add a new library to DPDK code base, the contributor must send + the following items to DPDK mailing list for technical board approval-in-principle. + + * Purpose of the library. + * Scope of work: outline the various additional tasks planned for this library, such as + developing new test applications, adding new drivers, and updating existing applications. + * Expected usage models of the library. + * Any licensing constraints. + * Justification for adding to DPDK. + * Any other implementations of the same functionality in other libraries/projects and how this + version differs. + * Public API specification header file as RFC. + + * Optional and good to have. + * Technical board may additionally request this collateral if needed to get more clarity + on scope and purpose. + * Any new library dependencies to DPDK. + +#. Technical board to schedule discussion on this in upcoming technical board meeting along with + author. Based on the technical board schedule and/or author availability, technical board may + need a maximum of **five** technical board meeting slots. + +#. Based on mailing list and technical board meeting discussions, technical board to vote and share + the decision in the mailing list. The decision outcome can be any of the following. + + * Approved in principal + * Not approved + * Further information needed + +#. Once technical board approves the library in principle, it is safe to start working on the + implementation. However, the patches will need to meet the usual quality criteria in order to be + effectively accepted.