X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcontributing%2Fstable.rst;h=20b081670345732f37d083fa1b4674400bde5d29;hb=22a2f54f2534258aa8ebb71cd2109f84968d4f9e;hp=6a5eee9bd495d5ff944fdaacd2aee7ab0afe54a0;hpb=219a6e74cab5c6a8cefc7bd2b0f18275835fef2f;p=dpdk.git diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst index 6a5eee9bd4..20b0816703 100644 --- a/doc/guides/contributing/stable.rst +++ b/doc/guides/contributing/stable.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2018 The DPDK contributors -.. stable_lts_releases: +.. _stable_lts_releases: DPDK Stable Releases and Long Term Support ========================================== @@ -25,10 +25,11 @@ Release to indicate longer term support. Stable Releases --------------- -Any major release of DPDK can be designated as a Stable Release if a +Any release of DPDK can be designated as a Stable Release if a maintainer volunteers to maintain it and there is a commitment from major -contributors to validate it before releases. If a release is to be designated -as a Stable Release, it should be done by 1 month after the master release. +contributors to validate it before releases. +If a version is to be a "Stable Release", it should be designated as such +within one month of that version being initially released. A Stable Release is used to backport fixes from an ``N`` release back to an ``N-1`` release, for example, from 16.11 to 16.07. @@ -51,7 +52,10 @@ agreement and a commitment from a maintainer. The current policy is that each year's November (X.11) release will be maintained as an LTS for 2 years. After the X.11 release, an LTS branch will be created for it at -http://git.dpdk.org/dpdk-stable where bugfixes will be backported to. +https://git.dpdk.org/dpdk-stable where bugfixes will be backported to. + +A LTS release may align with the declaration of a new major ABI version, +please read the :doc:`abi_policy` for more information. It is anticipated that there will be at least 4 releases per year of the LTS or approximately 1 every 3 months. However, the cadence can be shorter or @@ -59,7 +63,8 @@ longer depending on the number and criticality of the backported fixes. Releases should be coordinated with the validation engineers to ensure that a tagged release has been tested. -The current maintained LTS branches are 17.11 and 18.11. +For a list of the currently maintained stable/LTS branches please see +the latest `stable roadmap `_. At the end of the 2 years, a final X.11.N release will be made and at that point the LTS branch will no longer be maintained with no further releases. @@ -68,7 +73,7 @@ point the LTS branch will no longer be maintained with no further releases. What changes should be backported --------------------------------- -Backporting should be limited to bug fixes. All patches accepted on the master +Backporting should be limited to bug fixes. All patches accepted on the main branch with a Fixes: tag should be backported to the relevant stable/LTS branches, unless the submitter indicates otherwise. If there are exceptions, they will be discussed on the mailing lists. @@ -103,8 +108,8 @@ The Stable Mailing List The Stable and LTS release are coordinated on the stable@dpdk.org mailing list. -All fix patches to the master branch that are candidates for backporting -should also be CCed to the `stable@dpdk.org `_ +All fix patches to the main branch that are candidates for backporting +should also be CCed to the `stable@dpdk.org `_ mailing list. @@ -115,14 +120,7 @@ A Stable Release will be released by: * Tagging the release with YY.MM.n (year, month, number). * Uploading a tarball of the release to dpdk.org. -* Sending an announcement to the `announce@dpdk.org `_ +* Sending an announcement to the `announce@dpdk.org `_ list. -Stable releases are available on the `dpdk.org download page `_. - - -ABI ---- - -The Stable Release should not be seen as a way of breaking or circumventing -the DPDK ABI policy. +Stable releases are available on the `dpdk.org download page `_.