From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id BFCF843CF3; Tue, 19 Mar 2024 04:32:49 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 4A1C840281; Tue, 19 Mar 2024 04:32:49 +0100 (CET) Received: from mail-qt1-f170.google.com (mail-qt1-f170.google.com [209.85.160.170]) by mails.dpdk.org (Postfix) with ESMTP id 7A7024021E; Tue, 19 Mar 2024 04:32:47 +0100 (CET) Received: by mail-qt1-f170.google.com with SMTP id d75a77b69052e-42a029c8e76so38768761cf.2; Mon, 18 Mar 2024 20:32:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1710819167; x=1711423967; darn=dpdk.org; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=HGjZ6SOLhuXpOEVigUotDBuRZ2WJM3mlbWi4WWLydwM=; b=E4VK/3FG7g8lFkrjiQpG4W6lr7pxNVkPiFu2AUFLe1Y92Nb5RARTLbmw4F/LENJFpE zEYp1jSaXTka8hOcJDgaSTFgTOci8ueKPLXXiWHGewi1ZOhqmltJb4WZjVCU4+hRMKKh tYcdaX2o655EFxJNOe/cVfuTzxx9UFI3mp+Dd24QVifNhzDtTnuSxIZAT5TuadPc0JCv EARiaIG2jsQ0Dq/ooaH7p5fa1kQlYADksP1BD01mVUCd5spVTnMEQsA7BAojv/4AeeV1 CiZJm2mVwj6fRZrMSiRUbL0K43/JCCFOdyqqCPDmeSDRvp7ZDRVmAQ2w4WHGdW60hhIF iNTQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1710819167; x=1711423967; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=HGjZ6SOLhuXpOEVigUotDBuRZ2WJM3mlbWi4WWLydwM=; b=vpzxPIfTsQxyOdKZuC//A2CJlXfaMQ4jP6sA+8oifbrR62NEOdmvSPtJCeunkVNNQ6 LoBVMIrSfrvofDNH8lUl+WfNrEOdRQU8Er3fkREMqEyI4AE9W2pOeiV6RO7amSpDeWUH RpX+hmXZQ4O0NKtgmQxr26M8kXTEmOYgv+ziN19961EUxYm/F8u5Q2xZt86Gv00J/0ve NolQCzHd1ldyl7DQgRAt0ujLCpo+JDn+hFBL4BZbHsjfPw8UK47XsRezzx8mc3wtygI4 xet/CUaGTnaGde078oRqiN7QC4W7qXGC3A2GiecXmZNJHJAeegvnCjwcPcY8Zu6UubP3 QkfQ== X-Forwarded-Encrypted: i=1; AJvYcCVvJo7FBr0sEerPWQ2jsBnyjCNcicTjXUwPRFOLHsKWB4F9WZLTr2jUTqRmcxTZMO90ZGFpj9Y8kxCFTKlvaxWKFkqSkngMmRIfmDrJzzQUsq3uMGmD X-Gm-Message-State: AOJu0YyR6y5QFeBisIwj6Te+p+kU3YKr0mHiPMTDXSYoCFfiRy87seti xG4fiQV6LjdHnaB0at3JsGxGj/5g5VPC5YIuWex3AhCyA8SCsOQNtiL+VTpvqOSccXi6lN+uifl JhJhts2JEukUTpO0aE7u7pPXpHeU= X-Google-Smtp-Source: AGHT+IGoEl5z5lZeMwSS5qSEdRqjjdtPaWfHz06DoZBp9izGPJDhfJ39RMlE9eNHVJu6+3/E6MHMA2GH/mH0Xmc1Wmk= X-Received: by 2002:a05:622a:cd:b0:430:df57:c409 with SMTP id p13-20020a05622a00cd00b00430df57c409mr2426615qtw.18.1710819166635; Mon, 18 Mar 2024 20:32:46 -0700 (PDT) MIME-Version: 1.0 References: <20240108075850.4151361-1-jerinj@marvell.com> <20240109141009.497807-1-jerinj@marvell.com> In-Reply-To: <20240109141009.497807-1-jerinj@marvell.com> From: Jerin Jacob Date: Tue, 19 Mar 2024 09:02:20 +0530 Message-ID: Subject: Re: [dpdk-dev] [v6] doc: define qualification criteria for external library To: jerinj@marvell.com Cc: dev@dpdk.org, techboard@dpdk.org, govboard@dpdk.org, Thomas Monjalon Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable 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 On Tue, Jan 9, 2024 at 7:40=E2=80=AFPM wrote: > > 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 > https://mails.dpdk.org/archives/dev/2024-January/284849.html > > Signed-off-by: Jerin Jacob > Acked-by: Thomas Monjalon Ping for merge > --- > > v6: > - Address Morten's comments at https://mails.dpdk.org/archives/dev/2024-J= anuary/285029.html > > v5: > - Added "Dependency nature" section based on Stephen's input > > v4: > - Address Thomas comments from https://patches.dpdk.org/project/dpdk/patc= h/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. > > doc/guides/contributing/index.rst | 1 + > .../contributing/library_dependency.rst | 53 +++++++++++++++++++ > 2 files changed, 54 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..3b275f1c52 > --- /dev/null > +++ b/doc/guides/contributing/library_dependency.rst > @@ -0,0 +1,53 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2024 Marvell. > + > +External Library dependency > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D > + > +This document defines the qualification criteria for external libraries = that may be > +used as dependencies in DPDK drivers or libraries. > +The final decision to accept or reject is at the discretion of the DPDK = Project's Technical Board. > + > +#. **Documentation:** > + > + - Must have adequate documentation for the steps to build it. > + - Must have clear license documentation on distribution and usage asp= ects of external library. > + > +#. **Free availability:** > + > + - The library must be freely available to build in either source or b= inary 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., G= PLv3) licenses are acceptable. > + - In the case of a permissive license, automatic inclusion in the bui= ld process is assumed. > + For non-permissive licenses, an additional build configuration opti= on is required. > + > +#. **Distribution License:** > + > + - No specific constraints, but clear documentation on distribution us= age aspects is required. > + > +#. **Compiler compatibility:** > + > + - The library must be able to compile with a DPDK supported compiler = for the given target > + environment. > + For example, for Linux, the library must be able to compile with GC= C and/or clang. > + - Library may be limited to a specific OS and/or specific hardware. > + > +#. **Meson build integration:** > + > + - The library must have standard method like ``pkg-config`` for seaml= ess integration with > + DPDK's build environment. > + > +#. **Code readability:** > + > + - Optional dependencies should use stubs to minimize ``ifdef`` clutte= r, promoting improved > + code readability. > + > +#. **Dependency nature:** > + > + - The external library dependency must be optional. > + i.e Missing external library must not impact the core functionality= of the DPDK, specific > + library and/or driver will not be built if dependencies are not met= . > -- > 2.43.0 >