From patchwork Tue Jul 7 17:51:00 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ray Kinsella X-Patchwork-Id: 73461 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 40122A00BE; Tue, 7 Jul 2020 19:51:15 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 34F901DE40; Tue, 7 Jul 2020 19:51:14 +0200 (CEST) Received: from dal2relay75.mxroute.com (dal2relay75.mxroute.com [64.40.26.75]) by dpdk.org (Postfix) with ESMTP id 689BD1DE40 for ; Tue, 7 Jul 2020 19:51:13 +0200 (CEST) Received: from filter004.mxroute.com ([149.28.56.236] 149.28.56.236.vultr.com) (Authenticated sender: mN4UYu2MZsgR) by dal2relay75.mxroute.com (ZoneMTA) with ESMTPSA id 1732a672f5e0005b7b.002 for (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES128-GCM-SHA256); Tue, 07 Jul 2020 17:51:12 +0000 X-Zone-Loop: 24fca57fbe1cb539b4531ffe75252e25d3bfe2055b14 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 11AB13EDA4; Tue, 7 Jul 2020 17:51:11 +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:00 +0100 Message-Id: <1594144262-5040-2-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 1/2] doc: reword abi policy for windows 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" Minor changes to the abi policy for windows. Signed-off-by: Ray Kinsella --- doc/guides/contributing/abi_policy.rst | 4 +++- doc/guides/windows_gsg/intro.rst | 6 +++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index d0affa9..4452362 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -40,7 +40,9 @@ General Guidelines maintaining ABI stability through one year of DPDK releases starting from DPDK 19.11. This policy will be reviewed in 2020, with intention of lengthening the stability period. Additional implementation detail can be - found in the :ref:`release notes <20_02_abi_changes>`. + found in the :ref:`release notes <20_02_abi_changes>`. Please note that this + policy does not currently apply to the :doc:`Windows build + <../windows_gsg/intro>`. What is an ABI? ~~~~~~~~~~~~~~~ diff --git a/doc/guides/windows_gsg/intro.rst b/doc/guides/windows_gsg/intro.rst index 58c6246..4ac7f97 100644 --- a/doc/guides/windows_gsg/intro.rst +++ b/doc/guides/windows_gsg/intro.rst @@ -19,6 +19,6 @@ compile. Support is being added in pieces so as to limit the overall scope of any individual patch series. The goal is to be able to run any DPDK application natively on Windows. -The :doc:`../contributing/abi_policy` cannot be respected for Windows. -Minor ABI versions may be incompatible -because function versioning is not supported on Windows. +The :doc:`../contributing/abi_policy` does not apply to the Windows build, +as function versioning is not supported on Windows, +therefore minor ABI versions may be incompatible. From patchwork Tue Jul 7 17:51:01 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ray Kinsella X-Patchwork-Id: 73463 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 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 Reviewed-by: Honnappa Nagarahalli --- 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.