From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id A421CA00BE; Tue, 7 Jul 2020 19:51:28 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 5D6011DECC; Tue, 7 Jul 2020 19:51:21 +0200 (CEST) Received: from qrelay216.mxroute.com (qrelay216.mxroute.com [172.82.139.216]) by dpdk.org (Postfix) with ESMTP id 22BA81DECB for ; Tue, 7 Jul 2020 19:51:20 +0200 (CEST) Received: from filter004.mxroute.com ([149.28.56.236] 149.28.56.236.vultr.com) (Authenticated sender: mN4UYu2MZsgR) by qrelay216.mxroute.com (ZoneMTA) with ESMTPA id 1732a673e9500027dd.002 for ; Tue, 07 Jul 2020 17:51:16 +0000 X-Zone-Loop: 966a081cec0689ff9066600571a497c490ba79eda2b3 X-Originating-IP: [149.28.56.236] Received: from echo.mxrouting.net (echo.mxrouting.net [116.202.222.109]) by filter004.mxroute.com (Postfix) with ESMTPS id 529993EDA8; Tue, 7 Jul 2020 17:51:15 +0000 (UTC) From: Ray Kinsella To: dev@dpdk.org Cc: fady@mellanox.com, thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, Ray Kinsella , Neil Horman , John McNamara , Marko Kovacevic , Harini Ramakrishnan , Omar Cardona , Pallavi Kadam , Ranjit Menon Date: Tue, 7 Jul 2020 18:51:01 +0100 Message-Id: <1594144262-5040-3-git-send-email-mdr@ashroe.eu> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1594144262-5040-1-git-send-email-mdr@ashroe.eu> References: <1594133126-2518-1-git-send-email-mdr@ashroe.eu> <1594144262-5040-1-git-send-email-mdr@ashroe.eu> X-AuthUser: mdr@ashroe.eu Subject: [dpdk-dev] [PATCH v2 2/2] doc: clarify alias to experimental period 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" Clarify retention period for aliases to experimental. Signed-off-by: Ray Kinsella --- doc/guides/contributing/abi_versioning.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst index 31a9205..b1d09c7 100644 --- a/doc/guides/contributing/abi_versioning.rst +++ b/doc/guides/contributing/abi_versioning.rst @@ -158,7 +158,7 @@ The macros exported are: * ``VERSION_SYMBOL_EXPERIMENTAL(b, e)``: Creates a symbol version table entry binding versioned symbol ``b@EXPERIMENTAL`` to the internal function ``be``. The macro is used when a symbol matures to become part of the stable ABI, to - provide an alias to experimental for some time. + provide an alias to experimental until the next major ABI version. .. _example_abi_macro_usage: @@ -428,8 +428,9 @@ _____________________________ In situations in which an ``experimental`` symbol has been stable for some time, and it becomes a candidate for promotion to the stable ABI. At this time, when -promoting the symbol, maintainer may choose to provide an alias to the +promoting the symbol, the maintainer may choose to provide an alias to the ``experimental`` symbol version, so as not to break consuming applications. +This alias is then dropped in the next major ABI version. The process to provide an alias to ``experimental`` is similar to that, of :ref:`symbol versioning ` described above. -- 2.7.4