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 AB770A0545; Thu, 30 Jun 2022 11:42:08 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9EDF141143; Thu, 30 Jun 2022 11:42:08 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id A101741138 for ; Thu, 30 Jun 2022 11:42:07 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1656582127; 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=tnyyK0vyKBbSwRHCHbGY46a2e8H+kTQO/WawPKrGE7s=; b=NS3r/3dzkZqwjjd3xtRJmPCf37E+vp4XaFxwPalbWYYGylr1SDQhTrMwhE9tgrco6pqXom 3GyA6c7zEZIkDkqCYo7z1/9tyNYNfkLL2KWGTZGGYxaRe2ABoLqhklLPm6wWYHHMCNxp8W U3OEEwQ0yJlhMLCNxyDpSIlUStNTEY8= Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-570-ffBz_9mANkO9rPn3HYky_g-1; Thu, 30 Jun 2022 05:42:03 -0400 X-MC-Unique: ffBz_9mANkO9rPn3HYky_g-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 671AD3C11723; Thu, 30 Jun 2022 09:42:03 +0000 (UTC) Received: from fchome.redhat.com (unknown [10.40.194.174]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9EB301415108; Thu, 30 Jun 2022 09:42:02 +0000 (UTC) From: David Marchand To: dev@dpdk.org, techboard@dpdk.org Cc: Ray Kinsella Subject: [PATCH] doc: announce marking bus object as internal Date: Thu, 30 Jun 2022 11:41:53 +0200 Message-Id: <20220630094153.2066208-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 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_bus is unnecessarily exposed in the public API/ABI. Besides, we had cases where extending rte_bus was necessary. Announce that rte_bus will be made opaque in the public API and mark associated API as internal. Signed-off-by: David Marchand --- A RFC series of the intended changes is available at: https://patches.dpdk.org/project/dpdk/list/?series=23811&state=%2A&archive=both --- doc/guides/rel_notes/deprecation.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 64d649777a..a9fd6676be 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -32,6 +32,12 @@ Deprecation Notices ``__atomic_thread_fence`` must be used for patches that need to be merged in 20.08 onwards. This change will not introduce any performance degradation. +* bus: The ``rte_bus`` object will be made opaque in DPDK 22.11. + The goal is to remove it from the public ABI and make this object extendable. + As a side effect, registering a bus will be marked as an internal API: + external users may still register their bus using a new 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. -- 2.36.1