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 C0BA94334C; Fri, 17 Nov 2023 05:34:26 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 46C6B4069D; Fri, 17 Nov 2023 05:34:26 +0100 (CET) Received: from mail-qt1-f179.google.com (mail-qt1-f179.google.com [209.85.160.179]) by mails.dpdk.org (Postfix) with ESMTP id 26BB540271; Fri, 17 Nov 2023 05:34:25 +0100 (CET) Received: by mail-qt1-f179.google.com with SMTP id d75a77b69052e-41cd7a3e8f8so9578801cf.0; Thu, 16 Nov 2023 20:34:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1700195664; x=1700800464; 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=VxrvML34KFC7rNasf72x5HdPQHTTYVbXQ4r0CvTrmAg=; b=QBOIeme17KwYHB4sWrhF81wVn2gzTP/fXFBzGKE5H9UmS6/c0Xu+TbFm4+ld0PWGwz YL5/s5LKPbyJNwyOpwuKuMIH7RkqPbpiivFPh3YziKvs09EEsCB260B9RECgO+BCUjsU 6VUwCkZa7hCzTV8/IonFXqZ2oGHmbdBP1Wfo3AKz/6cEcHz8zNssbXMpuJ0c2rhAJZxN RKRFXAaiDmWXBrnGA5THc/Ce16tAfBq1cZUwyfF+MHOmrcOoytyilTGCxHVOMrzorqrW Pu50UwHum/4Gne16wKs2346r+13sG1hwPpBYlw82gEYhmCYwUfAAVSFrxpA7dR9tGypg s1LQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700195664; x=1700800464; 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=VxrvML34KFC7rNasf72x5HdPQHTTYVbXQ4r0CvTrmAg=; b=Z9TPGh7CFdMdaEll1iiRVudlFI5B5mCWGgax5kvYRo8gelg5D8U8v6cit4PJnBlhGf LNLUjH8mIXVcPrKfSAMiaczIxSR/cE1LWwLNwtnCr1riBbkVppA2ywst4CtwNJ6C8G5q nCtej361Rr3Mc/YKrWvV7PztaMB7iR9NYPmD5AmYRjLLovFsmX/JRbg3knx5qx5z9QbI ed5CGdVuTIfkPh16416gNPNsW510LMyh5MAmPOkxxE46+WrmDRxGOIKyDr8LTqaUaZ7w aSwDPlfqAWJw9LDSusMW0admGT/sGufooDhV2rm8YvyeX3Iuc+E2X8mijBnh98g33wTd aLZQ== X-Gm-Message-State: AOJu0YwfYeV2ZhbXJ00VGdpqPUgeIPnms6qoKChsQc2lBQLdOQR/zCA6 0I79VntsN8ctUBVMsLtxWuNug+eGbvXOywG8mMk= X-Google-Smtp-Source: AGHT+IGkP9hD0SI+ECzofRarMa0cgQghqXnKah7ZvOBamNtkbrMTSK4qlQNW2/SrPp4TTKkmpXRSiUwzCD32OcI7kUw= X-Received: by 2002:ac8:5d8b:0:b0:419:4e1c:6904 with SMTP id d11-20020ac85d8b000000b004194e1c6904mr13093538qtx.20.1700195664365; Thu, 16 Nov 2023 20:34:24 -0800 (PST) MIME-Version: 1.0 References: <20230928051648.562526-1-jerinj@marvell.com> <20230928054036.645183-1-jerinj@marvell.com> In-Reply-To: <20230928054036.645183-1-jerinj@marvell.com> From: Jerin Jacob Date: Fri, 17 Nov 2023 10:03:57 +0530 Message-ID: Subject: Re: [dpdk-dev] [PATCH v2] doc: define qualification criteria for external library To: jerinj@marvell.com Cc: dev@dpdk.org, techboard@dpdk.org 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 Thu, Sep 28, 2023 at 11:10=E2=80=AFAM 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 > > Signed-off-by: Jerin Jacob Ping for review and/or merge. > --- > 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 > +=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. > + > +- **Free availability**: The library must be freely available to build i= n 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 libra= ry must be able to compile > + with GCC and/or clang. > + > +- **Documentation**: Must have adequate documentation for the steps to b= uild it. > + > +- **Meson build integration**: The library must have standard method lik= e ``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. > -- > 2.42.0 >