From patchwork Tue Jul 7 14:45:24 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ray Kinsella X-Patchwork-Id: 73439 X-Patchwork-Delegate: thomas@monjalon.net 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 5DC65A00BE; Tue, 7 Jul 2020 16:45:56 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 84DB41DE76; Tue, 7 Jul 2020 16:45:47 +0200 (CEST) Received: from dal2relay156.mxroute.com (dal2relay156.mxroute.com [64.40.26.156]) by dpdk.org (Postfix) with ESMTP id D6AFC1DE49 for ; Tue, 7 Jul 2020 16:45:45 +0200 (CEST) Received: from filter003.mxroute.com ([168.235.111.26] 168-235-111-26.cloud.ramnode.com) (Authenticated sender: mN4UYu2MZsgR) by dal2relay156.mxroute.com (ZoneMTA) with ESMTPSA id 17329bd52da0005b7b.002 for (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES128-GCM-SHA256); Tue, 07 Jul 2020 14:45:40 +0000 X-Zone-Loop: 34bb24f16af443b36d4f88839d026b933cef409fc634 X-Originating-IP: [168.235.111.26] Received: from echo.mxrouting.net (echo.mxrouting.net [116.202.222.109]) by filter003.mxroute.com (Postfix) with ESMTPS id 430F46004E; Tue, 7 Jul 2020 14:45:39 +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 15:45:24 +0100 Message-Id: <1594133126-2518-3-git-send-email-mdr@ashroe.eu> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1594133126-2518-1-git-send-email-mdr@ashroe.eu> References: <1594133126-2518-1-git-send-email-mdr@ashroe.eu> X-AuthUser: mdr@ashroe.eu Subject: [dpdk-dev] [PATCH v1 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 | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst index 31a9205..e00dfa8 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 -``experimental`` symbol version, so as not to break consuming applications. +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 will then typically be 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.