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 4FD05A0032; Mon, 11 Jul 2022 17:01:52 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3F3C340DF6; Mon, 11 Jul 2022 17:01:52 +0200 (CEST) Received: from mail-qt1-f180.google.com (mail-qt1-f180.google.com [209.85.160.180]) by mails.dpdk.org (Postfix) with ESMTP id 1935E40C35; Mon, 11 Jul 2022 17:01:50 +0200 (CEST) Received: by mail-qt1-f180.google.com with SMTP id 23so7192323qtt.3; Mon, 11 Jul 2022 08:01:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=BVjYgxes5VJYbGS+8js3m8+2704a+GuCf0MyGREhtic=; b=FR5slCCEqgbVlR1Rft1ymRebJivw4VYG7rmIq6jiV6GsTOLincp4ikQLgiUUSqxFXa F+rffJRgQ2v9lFfuuyKkXPZoadBPjwHxv8s0fAZAxxYFVvN8OSc9vkzBgujYyowmy5oX FLvpO/LMo1Wwpshl0WDbSG5EenJ0D/SAyrfBAxv/jMAcmuPhJiPfl49TrYzrETPq4ZMH 7dyaX38DkiXZcg19cvq5jRe0LyVYb31/iMbrBm1lJiybLUNRlaXwc1q0u+SQuZdHVzte CxN3Yk6LRROEfnUg+eV3jXWaZSvl9RYazeAcrPary+75sZhSYJIqvKvHn3hTw/RQDia1 zIYw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=BVjYgxes5VJYbGS+8js3m8+2704a+GuCf0MyGREhtic=; b=mFDu0EHiZ/bLkeskSO2VvIm7isCk3GMzvuLEA7fHjOv9Gdt6KXKFfKJpweeVMZzJLO JLMqG13S3VUzw6qmNagc8ZnyHBEdGHTExdVNw2tg60mKMZSZzw77rIrgz1fa32YhbY/5 SC7IuuEgCsx1P8KvyDzl8HzqN1vm3APTl0p/J/9pfoTxxLCPmcE+pHYKbFhUUygEjJLW C3jP9RbSb0ZUktd+8I3Pquzph2RwO1OvA0mHSipxFCCcyKAxmINbzhQvNuImNdNO3lFN 0awomjWN8+U0QDaHYwJvopQPsd710nGzcvhMQJZkNYa66jtv0FlKgn++ytEiCCuoFtNH dRFg== X-Gm-Message-State: AJIora9xhhgRdZcj6EpsaQReFXkvYmkdq2m2H8e5NyFk1MZi6D6VHYG9 9mGtCXiPqupWa8F4yGyRjpkBahSNbTm8Gzo0Ij4= X-Google-Smtp-Source: AGRyM1t6GyBlqogvN3j/3+Cv9yWfJad9Uk4Dh9x3++cuC9+/6HQRgFqPnFKV7t0t664c/655qHXh4NUBP4C0oanNA1Q= X-Received: by 2002:ac8:5b06:0:b0:31d:3b22:c8dd with SMTP id m6-20020ac85b06000000b0031d3b22c8ddmr14149915qtw.410.1657551708786; Mon, 11 Jul 2022 08:01:48 -0700 (PDT) MIME-Version: 1.0 References: <20220710061736.973563-1-david.marchand@redhat.com> In-Reply-To: <20220710061736.973563-1-david.marchand@redhat.com> From: Jerin Jacob Date: Mon, 11 Jul 2022 20:31:22 +0530 Message-ID: Subject: Re: [PATCH] doc: announce marking device and driver objects as internal To: David Marchand Cc: dpdk-dev , techboard@dpdk.org, Ray Kinsella Content-Type: text/plain; charset="UTF-8" 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 Sun, Jul 10, 2022 at 11:48 AM David Marchand wrote: > > rte_driver and rte_device are unnecessarily exposed in the public API/ABI. > Announce that they will be made opaque in the public API and mark > associated API as internal. > This impacts all bus, as their driver registration mechanism will be > made internal. > > Note: the PCI bus had a similar deprecation notice that we can remove as > the new one is more generic. > > Signed-off-by: David Marchand Acked-by: Jerin Jacob > --- > doc/guides/rel_notes/deprecation.rst | 12 +++++++----- > 1 file changed, 7 insertions(+), 5 deletions(-) > > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst > index a9fd6676be..b9cc267b30 100644 > --- a/doc/guides/rel_notes/deprecation.rst > +++ b/doc/guides/rel_notes/deprecation.rst > @@ -38,6 +38,13 @@ Deprecation Notices > external users may still register their bus using a new driver header (see > ``enable_driver_sdk`` meson option). > > +* drivers: As a followup on the work on the ``rte_bus`` object, the > + ``rte_driver`` and ``rte_device`` objects (and as a domino effect, their > + bus-specific counterparts) will be made opaque in DPDK 22.11. > + Registering a driver on a bus will be marked as an internal API: > + external users may still register their drivers using the bus specific > + driver header (see ``enable_driver_sdk`` meson option). > + > * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated and will > be removed in DPDK 22.11. The replacement macro > ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only. > @@ -49,11 +56,6 @@ Deprecation Notices > * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and > will be removed in DPDK 22.11. > > -* pci: To reduce unnecessary ABIs exposed by DPDK bus driver, "rte_bus_pci.h" > - will be made internal in 21.11 and macros/data structures/functions defined > - in the header will not be considered as ABI anymore. This change is inspired > - by the RFC https://patchwork.dpdk.org/project/dpdk/list/?series=17176. > - > * lib: will fix extending some enum/define breaking the ABI. There are multiple > samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is > used by iterators, and arrays holding these values are sized with this > -- > 2.36.1 >