Cover Detail
Show a cover letter.
GET /api/covers/57392/?format=api
{ "id": 57392, "url": "https://patches.dpdk.org/api/covers/57392/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/cover/1564760338-6408-1-git-send-email-mdr@ashroe.eu/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1564760338-6408-1-git-send-email-mdr@ashroe.eu>", "list_archive_url": "https://inbox.dpdk.org/dev/1564760338-6408-1-git-send-email-mdr@ashroe.eu", "date": "2019-08-02T15:38:55", "name": "[v2,0/3] doc: changes to abi policy introducing major abi versions", "submitter": { "id": 1310, "url": "https://patches.dpdk.org/api/people/1310/?format=api", "name": "Ray Kinsella", "email": "mdr@ashroe.eu" }, "mbox": "https://patches.dpdk.org/project/dpdk/cover/1564760338-6408-1-git-send-email-mdr@ashroe.eu/mbox/", "series": [ { "id": 5894, "url": "https://patches.dpdk.org/api/series/5894/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=5894", "date": "2019-08-02T15:38:55", "name": "doc: changes to abi policy introducing major abi versions", "version": 2, "mbox": "https://patches.dpdk.org/series/5894/mbox/" } ], "comments": "https://patches.dpdk.org/api/covers/57392/comments/", "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 99DDA1D503;\n\tFri, 2 Aug 2019 17:39:21 +0200 (CEST)", "from qrelay241.mxroute.com (qrelay241.mxroute.com [172.82.139.241])\n\tby dpdk.org (Postfix) with ESMTP id D78C61D500\n\tfor <dev@dpdk.org>; Fri, 2 Aug 2019 17:39:19 +0200 (CEST)", "from filter001.mxrelay.co (unknown [116.203.155.46])\n\tby qrelay241.mxroute.com (Postfix) with ESMTP id EF6F2301D37;\n\tFri, 2 Aug 2019 11:39:18 -0400 (EDT)", "from galaxy.mxroute.com (unknown [23.92.70.113])\n\tby filter001.mxrelay.co (Postfix) with ESMTPS id 857A11000A7;\n\tFri, 2 Aug 2019 15:39:16 +0000 (UTC)", "from irdmzpr02-ext.ir.intel.com ([192.198.151.37] helo=localhost)\n\tby galaxy.mxroute.com with esmtpsa\n\t(TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128)\n\t(Exim 4.91) (envelope-from <mdr@ashroe.eu>)\n\tid 1htZZn-00052I-1a; Fri, 02 Aug 2019 11:34:39 -0400" ], "From": "Ray Kinsella <mdr@ashroe.eu>", "To": "dev@dpdk.org", "Cc": "mdr@ashroe.eu, thomas@monjalon.net, stephen@networkplumber.org,\n\tbruce.richardson@intel.com, ferruh.yigit@intel.com,\n\tkonstantin.ananyev@intel.com, jerinj@marvell.com,\n\tolivier.matz@6wind.com, \n\tnhorman@tuxdriver.com, maxime.coquelin@redhat.com, hemant.agrawal@nxp.com", "Date": "Fri, 2 Aug 2019 16:38:55 +0100", "Message-Id": "<1564760338-6408-1-git-send-email-mdr@ashroe.eu>", "X-Mailer": "git-send-email 2.7.4", "X-AuthUser": "mdr@ashroe.eu", "Subject": "[dpdk-dev] [PATCH v2 0/3] doc: changes to abi policy introducing\n\tmajor abi versions", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "TL;DR Abbreviation:\nA major ABI version that all DPDK releases during a one year period\nsupport. ABI versioning is managed at a project-level, in place of library-level\nmanagement. ABI changes to add new features are permitted, as long as ABI\ncompatibility with the major ABI version is maintained.\n\nDetail:\nThis patch introduces major ABI versions, supported for one year and released\naligned with the LTS release. This ABI version is then supported by all\nsubsequent releases within that one year period. The intention is that the one\nyear support period, will then be reviewed after the initial year with the\nintention of lengthing the support period for the next ABI version.\n\nABI changes that preserve ABI compatibility with the major ABI version are\npermitted in subsequent releases. ABI changes, follow similar approval rules as\nbefore with the additional gate of now requiring technical board approval. The\nmerging and release of ABI breaking changes would now be pushed to the\ndeclaration of the next major ABI version.\n\nThis change encourages developers to maintain ABI compatibility with the major\nABI version, by promoting a permissive culture around those changes that\npreserve ABI compatibility. This approach begins to align DPDK with those\nprojects that declare major ABI versions (e.g. version 2.x, 3.x) and support\nthose versions for some period, typically two years or more.\n\nTo provide an example of how this might work in practice:\n\n * DPDK v20 is declared as the supported ABI version for one year, aligned with\n the DPDK v19.11 (LTS) release. All library sonames are updated to reflect the\n new ABI version, e.g. librte_eal.so.20, librte_acl.so.20...\n * DPDK v20.02 .. v20.08 releases are ABI compatible with the DPDK v20 ABI. ABI\n changes are permitted from DPDK v20.02 onwards, with the condition that ABI\n compatibility with DPDK v20 is preserved.\n * DPDK v21 is declared as the new supported ABI version for two years, aligned\n with the DPDK v20.11 (LTS) release. The DPDK v20 ABI is now depreciated,\n library sonames are updated to v21 and ABI compatibility breaking changes may\n be introduced.\n\n---\n\nv2\n * Restructured the patch into 3 patches:\n 1. Splits the original versioning document into an ABI policy document\n and ABI versioning document.\n 2. Add changes to the policy document introducing major ABI versions.\n 3. Fixes up the versioning document in light of major ABI versioning. \n * Reduces the initial ABI stability from two years to one year, with a review\n after the first year.\n * Adds detail around ABI version handling for experimental libraries.\n * Adds detail around chain of responsility for removing deprecated symbols.\n\nRay Kinsella (3):\n doc: separate versioning.rst into version and policy\n doc: changes to abi policy introducing major abi versions\n doc: updates to versioning guide for abi versions\n\n doc/guides/contributing/abi_policy.rst | 283 ++++++++++++++\n doc/guides/contributing/abi_versioning.rst | 505 ++++++++++++++++++++++++\n doc/guides/contributing/index.rst | 3 +-\n doc/guides/contributing/stable.rst | 36 +-\n doc/guides/contributing/versioning.rst | 591 -----------------------------\n 5 files changed, 810 insertions(+), 608 deletions(-)\n create mode 100644 doc/guides/contributing/abi_policy.rst\n create mode 100644 doc/guides/contributing/abi_versioning.rst\n delete mode 100644 doc/guides/contributing/versioning.rst" }