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 3ABF4A00C2; Thu, 23 Apr 2020 12:12:27 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 2D4151D509; Thu, 23 Apr 2020 12:12:26 +0200 (CEST) Received: from qrelay205.mxroute.com (qrelay205.mxroute.com [172.82.139.205]) by dpdk.org (Postfix) with ESMTP id C1CCC1D455 for ; Thu, 23 Apr 2020 12:12:24 +0200 (CEST) Received: from filter004.mxroute.com ([149.28.56.236] 149.28.56.236.vultr.com) (Authenticated sender: mN4UYu2MZsgR) by qrelay205.mxroute.com (ZoneMTA) with ESMTPA id 171a686214a0000d83.001 for ; Thu, 23 Apr 2020 10:12:20 +0000 X-Zone-Loop: 2892686e0eba97644709e443cd84a6f99106f92074b8 X-Originating-IP: [149.28.56.236] Received: from galaxy.mxroute.com (unknown [23.92.70.113]) by filter004.mxroute.com (Postfix) with ESMTPS id AA7533EA09; Thu, 23 Apr 2020 10:12:14 +0000 (UTC) Received: from [192.198.151.43] (helo=localhost) by galaxy.mxroute.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.91) (envelope-from ) id 1jRYQO-0002hN-GF; Thu, 23 Apr 2020 05:45:40 -0400 From: Ray Kinsella To: dev@dpdk.org Cc: ferruh.yigit@intel.com, Ray Kinsella , Bruce Richardson , John McNamara , Marko Kovacevic Date: Thu, 23 Apr 2020 11:12:07 +0100 Message-Id: <1587636728-1619-1-git-send-email-mdr@ashroe.eu> X-Mailer: git-send-email 2.7.4 X-AuthUser: mdr@ashroe.eu Subject: [dpdk-dev] [PATCH v1] abi: document reasons behind the three part versioning 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 the reasons behind the three part version numbering scheme. Documents the fixes made in f26c2b3. Signed-off-by: Ray Kinsella Signed-off-by: Bruce Richardson --- doc/guides/contributing/abi_policy.rst | 3 ++- doc/guides/rel_notes/release_20_05.rst | 12 ++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index 05ca959..86e7dd9 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -39,7 +39,8 @@ General Guidelines releases, over a number of release cycles. This change begins with 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. + lengthening the stability period. Additional implementation detail can be + found in the :ref:`release notes <20_05_abi_changes>`. What is an ABI? ~~~~~~~~~~~~~~~ diff --git a/doc/guides/rel_notes/release_20_05.rst b/doc/guides/rel_notes/release_20_05.rst index 7f2049a..8653f7a 100644 --- a/doc/guides/rel_notes/release_20_05.rst +++ b/doc/guides/rel_notes/release_20_05.rst @@ -164,6 +164,7 @@ API Changes Also, make sure to start the actual text at the margin. ========================================================= +.. _20_05_abi_changes: ABI Changes ----------- @@ -180,6 +181,17 @@ ABI Changes Also, make sure to start the actual text at the margin. ========================================================= +* The soname for each stable ABI version should be just the ABI version major + number without the minor number. Unfortunately both major and minor were used + in the v19.11 release, causing version v20.x releases to be incompatible with + ABI v20.0. + + The `commit f26c2b3 + `_ + fixed the issue by switching from 2-part to 3-part ABI version numbers so that + we can keep v20.0 as soname and using the final digits to identify the DPDK + 20.x releases which are ABI compatible. + * No ABI change that would break compatibility with DPDK 20.02 and 19.11. -- 2.7.4