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 5C80DA00C4; Sun, 10 Jul 2022 08:17:56 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 07C7940684; Sun, 10 Jul 2022 08:17:56 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 397D54068E for ; Sun, 10 Jul 2022 08:17:54 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657433873; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=6pyJRLTG711Z/FfRix/uiJyRQLzaxi6BjpsMWanhaDY=; b=E2qEVTLj1UmbGoJFZkSfzuMreAJS4AFH4Rup9Jil5ZBT2E6jKam2I0mDioMB4t2MGXVXtw k8Htt/1N0q1HcCA0XWg0InavfmkhUkxmLGRrCur46WQyOLbEbZgmNFJ6fd5yENk9KgRKrr IT3aMK/5LdyNqVb2LyMrsRdaVch3ywg= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-489-SWe8fItAMTySEPSqnJwApw-1; Sun, 10 Jul 2022 02:17:50 -0400 X-MC-Unique: SWe8fItAMTySEPSqnJwApw-1 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id D13FF185A7A4; Sun, 10 Jul 2022 06:17:49 +0000 (UTC) Received: from localhost.localdomain (unknown [10.40.192.194]) by smtp.corp.redhat.com (Postfix) with ESMTP id D0C5840CF8F0; Sun, 10 Jul 2022 06:17:48 +0000 (UTC) From: David Marchand To: dev@dpdk.org, techboard@dpdk.org Cc: Ray Kinsella Subject: [PATCH] doc: announce marking device and driver objects as internal Date: Sun, 10 Jul 2022 08:17:36 +0200 Message-Id: <20220710061736.973563-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=david.marchand@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true 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 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 --- 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