From patchwork Tue Jun 23 13:49:51 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ferruh Yigit X-Patchwork-Id: 72040 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 9E4DAA0350; Tue, 23 Jun 2020 15:49:58 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 0BA011D66A; Tue, 23 Jun 2020 15:49:58 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id C48081D641 for ; Tue, 23 Jun 2020 15:49:56 +0200 (CEST) IronPort-SDR: HZc9ipJC8w0X1oCE0LIfHDDzi5PealEmyv61RKwLwcxHtERwaM8N6eF5RLaw5/OmsW5m4FPYRd 6itHq2hh1Scw== X-IronPort-AV: E=McAfee;i="6000,8403,9660"; a="141564957" X-IronPort-AV: E=Sophos;i="5.75,271,1589266800"; d="scan'208";a="141564957" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 23 Jun 2020 06:49:55 -0700 IronPort-SDR: tnlggyujHvQBysuPNhSlcjdbjNf+3zLECO1KRcVUiPfyZ2Re5z8Q9mpY8P31B8EnLVJvpFeDY3 Az8z40byyUyw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.75,271,1589266800"; d="scan'208";a="319163562" Received: from silpixa00399752.ir.intel.com (HELO silpixa00399752.ger.corp.intel.com) ([10.237.222.180]) by FMSMGA003.fm.intel.com with ESMTP; 23 Jun 2020 06:49:53 -0700 From: Ferruh Yigit To: Ray Kinsella , Neil Horman , John McNamara , Marko Kovacevic Cc: dev@dpdk.org, Ferruh Yigit , David Marchand , Thomas Monjalon , Andrew Rybchenko Date: Tue, 23 Jun 2020 14:49:51 +0100 Message-Id: <20200623134952.1273562-1-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.25.4 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH] doc: mark internal symbols in ethdev X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The APIs are marked in the doxygen comment but better to mark the symbols too. This is planned for v20.11 release. Signed-off-by: Ferruh Yigit Acked-by: Andrew Rybchenko Acked-by: Ray Kinsella Acked-by: Thomas Monjalon --- 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 0bee92425..0b0f75720 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -98,6 +98,12 @@ Deprecation Notices Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status`` APIs can be used as replacement. +* ethdev: Some internal APIs for driver usage are exported in the .map file. + Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move + them to the INTERNAL block in .map. Although these APIs are internal it will + break the ABI checks, that is why change is planned for 20.11. + The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``. + * traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made ABI stable in the v19.11 release. The TM maintainer and other contributors have agreed to keep the TM APIs as experimental in expectation of additional spec