doc: changes to abi policy introducing major abi versions
v8 cover doc: changes to abi policy introducing major abi versions
TL;DR abbreviation:
A major ABI version that all DPDK releases during an agreed period support. ABI versioning is managed at a project-level, in place of library-level management. ABI changes to add new features are permitted, as long as ABI compatibility with the major ABI version is maintained.
Detail:
This patch introduces major ABI versions, released aligned with the LTS release and maintained for one year through subsequent releases. The intention is that the one year abi support period, will then be reviewed after the initial year with the intention of lengthening the period for the next ABI version.
ABI changes that preserve ABI compatibility with the major ABI version are permitted in subsequent releases. ABI changes, follow similar approval rules as before with the additional gate of now requiring technical board approval. The merging and release of ABI breaking changes would now be pushed to the declaration of the next major ABI version.
This change encourages developers to maintain ABI compatibility with the major ABI version, by promoting a permissive culture around those changes that preserve ABI compatibility. This approach begins to align DPDK with those projects that declare major ABI versions (e.g. version 2.x, 3.x) and support those versions for some period, typically two years or more.
To provide an example of how this might work in practice:
* DPDK v20 is declared as the supported ABI version for one year, aligned with the DPDK v19.11 (LTS) release. All library sonames are updated to reflect the new ABI version, e.g. librte_eal.so.20, librte_acl.so.20...
* DPDK v20.02 .. v20.08 releases are ABI compatible with the DPDK v20 ABI. ABI changes are permitted from DPDK v20.02 onwards, with the condition that ABI compatibility with DPDK v20 is preserved.
* DPDK v21 is declared as the new supported ABI version for two years, aligned with the DPDK v20.11 (LTS) release. The DPDK v20 ABI is now depreciated, library sonames are updated to v21 and ABI compatibility breaking changes may be introduced.
v8
* Fixed intermediate build warnings, figure annotations and typo's. (as suggested by John McNamara).
v7
* PNGs are now SVG. Some additional clarifications. Fixed typos and grammatical errors. (as suggested by Thomas Monjalon and David Marchand)
v6
* Added figure to abi_policy.rst, comparing and contrasting the DPDK abi and api. (as suggested by Aaron Conole)
v5
* Added figure to abi_policy.rst, mapping abi versions and abi compatibility to DPDK releases. (as suggested by Neil Horman)
v4
* Removed changes to stable.rst, fixed typos and clarified the ABI policy "warning".
v3
* Added myself as the maintainer of the ABI policy.
* Updated the policy and versioning guides to use the year of the LTS+1 (e.g. v20), as the abi major version number.
v2
* Restructured the patch into 3 patches:
1. Splits the original versioning document into an ABI policy document and ABI versioning document.
2. Add changes to the policy document introducing major ABI versions.
3. Fixes up the versioning document in light of major ABI versioning.
* Reduces the initial ABI stability from two years to one year, with a review after the first year.
* Adds detail around ABI version handling for experimental libraries.
* Adds detail around chain of responsility for removing deprecated symbols.
Ray Kinsella (4):
doc: separate versioning.rst into version and policy
doc: changes to abi policy introducing major abi versions
doc: updates to versioning guide for abi versions
doc: add maintainer for abi policy
MAINTAINERS | 4 + doc/guides/contributing/abi_policy.rst | 321 ++++++ doc/guides/contributing/abi_versioning.rst | 515 ++++++++++ .../contributing/img/abi_stability_policy.svg | 1059 ++++++++++++++++++++ doc/guides/contributing/img/what_is_an_abi.svg | 382 +++++++ doc/guides/contributing/index.rst | 3 +- doc/guides/contributing/patches.rst | 6 +- doc/guides/contributing/stable.rst | 12 +- doc/guides/contributing/versioning.rst | 591 ----------- doc/guides/rel_notes/deprecation.rst | 6 +- 10 files changed, 2293 insertions(+), 606 deletions(-) create mode 100644 doc/guides/contributing/abi_policy.rst create mode 100644 doc/guides/contributing/abi_versioning.rst create mode 100644 doc/guides/contributing/img/abi_stability_policy.svg create mode 100644 doc/guides/contributing/img/what_is_an_abi.svg delete mode 100644 doc/guides/contributing/versioning.rst
Signature · 1 line
2.7.4
PATCH v8 1/4 doc: separate versioning.rst into version and policy
Separate versioning.rst into abi versioning and abi policy guidance, in preparation for adding more detail to the abi policy.
--- doc/guides/contributing/abi_policy.rst | 167 ++++++++ doc/guides/contributing/abi_versioning.rst | 427 +++++++++++++++++++++ doc/guides/contributing/index.rst | 3 +- doc/guides/contributing/patches.rst | 2 +- doc/guides/contributing/versioning.rst | 591 ----------------------------- doc/guides/rel_notes/deprecation.rst | 2 +- 6 files changed, 598 insertions(+), 594 deletions(-) create mode 100644 doc/guides/contributing/abi_policy.rst create mode 100644 doc/guides/contributing/abi_versioning.rst delete mode 100644 doc/guides/contributing/versioning.rst
doc/guides/contributing/abi_policy.rst new file +167 -0
@@ -0,0 +1,167 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + +DPDK ABI/API policy +=================== + +Description +----------- + +This document details some methods for handling ABI management in the DPDK. + +General Guidelines +------------------ + +#. Whenever possible, ABI should be preserved +#. ABI/API may be changed with a deprecation process +#. The modification of symbols can generally be managed with versioning +#. Libraries or APIs marked in ``experimental`` state may change without constraint +#. New APIs will be marked as ``experimental`` for at least one release to allow + any issues found by users of the new API to be fixed quickly +#. The addition of symbols is generally not problematic +#. The removal of symbols generally is an ABI break and requires bumping of the + LIBABIVER macro +#. Updates to the minimum hardware requirements, which drop support for hardware which + was previously supported, should be treated as an ABI change. + +What is an ABI +~~~~~~~~~~~~~~ + +An ABI (Application Binary Interface) is the set of runtime interfaces exposed +by a library. It is similar to an API (Application Programming Interface) but +is the result of compilation. It is also effectively cloned when applications +link to dynamic libraries. That is to say when an application is compiled to +link against dynamic libraries, it is assumed that the ABI remains constant +between the time the application is compiled/linked, and the time that it runs. +Therefore, in the case of dynamic linking, it is critical that an ABI is +preserved, or (when modified), done in such a way that the application is unable +to behave improperly or in an unexpected fashion. + + +ABI/API Deprecation +------------------- + +The DPDK ABI policy +~~~~~~~~~~~~~~~~~~~ + +ABI versions are set at the time of major release labeling, and the ABI may +change multiple times, without warning, between the last release label and the +HEAD label of the git tree. + +ABI versions, once released, are available until such time as their +deprecation has been noted in the Release Notes for at least one major release +cycle. For example consider the case where the ABI for DPDK 2.0 has been +shipped and then a decision is made to modify it during the development of +DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 +release and the modification will be made available in the DPDK 2.2 release. + +ABI versions may be deprecated in whole or in part as needed by a given +update. + +Some ABI changes may be too significant to reasonably maintain multiple +versions. In those cases ABI's may be updated without backward compatibility +being provided. The requirements for doing so are: + +#. At least 3 acknowledgments of the need to do so must be made on the + dpdk.org mailing list. + + - The acknowledgment of the maintainer of the component is mandatory, or if + no maintainer is available for the component, the tree/sub-tree maintainer + for that component must acknowledge the ABI change instead. + + - It is also recommended that acknowledgments from different "areas of + interest" be sought for each deprecation, for example: from NIC vendors, + CPU vendors, end-users, etc. + +#. The changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, + to provide more details about oncoming changes. + ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. + More preferred way to provide this information is sending the feature + as a separate patch and reference it in deprecation notice. + +#. A full deprecation cycle, as explained above, must be made to offer + downstream consumers sufficient warning of the change. + +Note that the above process for ABI deprecation should not be undertaken +lightly. ABI stability is extremely important for downstream consumers of the +DPDK, especially when distributed in shared object form. Every effort should +be made to preserve the ABI whenever possible. The ABI should only be changed +for significant reasons, such as performance enhancements. ABI breakage due to +changes such as reorganizing public structure fields for aesthetic or +readability purposes should be avoided. + +.. note:: + + Updates to the minimum hardware requirements, which drop support for hardware + which was previously supported, should be treated as an ABI change, and + follow the relevant deprecation policy procedures as above: 3 acks and + announcement at least one release in advance. + +Examples of Deprecation Notices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following are some examples of ABI deprecation notices which would be +added to the Release Notes: + +* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, + to be replaced with the inline function ``rte_foo()``. + +* The function ``rte_mbuf_grok()`` has been updated to include a new parameter + in version 2.0. Backwards compatibility will be maintained for this function + until the release of version 2.1 + +* The members of ``struct rte_foo`` have been reorganized in release 2.0 for + performance reasons. Existing binary applications will have backwards + compatibility in release 2.0, while newly built binaries will need to + reference the new structure variant ``struct rte_foo2``. Compatibility will + be removed in release 2.2, and all applications will require updating and + rebuilding to the new structure at that time, which will be renamed to the + original ``struct rte_foo``. + +* Significant ABI changes are planned for the ``librte_dostuff`` library. The + upcoming release 2.0 will not contain these changes, but release 2.1 will, + and no backwards compatibility is planned due to the extensive nature of + these changes. Binaries using this library built prior to version 2.1 will + require updating and recompilation. + +New API replacing previous one +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If a new API proposed functionally replaces an existing one, when the new API +becomes non-experimental then the old one is marked with ``__rte_deprecated``. +Deprecated APIs are removed completely just after the next LTS. + +Reminder that old API should follow deprecation process to be removed. + + +Experimental APIs +----------------- + +APIs marked as ``experimental`` are not considered part of the ABI and may +change without warning at any time. Since changes to APIs are most likely +immediately after their introduction, as users begin to take advantage of +those new APIs and start finding issues with them, new DPDK APIs will be +automatically marked as ``experimental`` to allow for a period of stabilization +before they become part of a tracked ABI. + +Note that marking an API as experimental is a multi step process. +To mark an API as experimental, the symbols which are desired to be exported +must be placed in an EXPERIMENTAL version block in the corresponding libraries' +version map script. +Secondly, the corresponding prototypes of those exported functions (in the +development header files), must be marked with the ``__rte_experimental`` tag +(see ``rte_compat.h``). +The DPDK build makefiles perform a check to ensure that the map file and the +C code reflect the same list of symbols. +This check can be circumvented by defining ``ALLOW_EXPERIMENTAL_API`` +during compilation in the corresponding library Makefile. + +In addition to tagging the code with ``__rte_experimental``, +the doxygen markup must also contain the EXPERIMENTAL string, +and the MAINTAINERS file should note the EXPERIMENTAL libraries. + +For removing the experimental tag associated with an API, deprecation notice +is not required. Though, an API should remain in experimental state for at least +one release. Thereafter, normal process of posting patch for review to mailing +list can be followed.
doc/guides/contributing/abi_versioning.rst new file +427 -0
427 lines not on this page · raw message
doc/guides/contributing/index.rst +2 -1
@@ -10,7 +10,8 @@ Contributor's Guidelines coding_style design - versioning + abi_policy + abi_versioning documentation patches vulnerability
doc/guides/contributing/patches.rst +1 -1
@@ -157,7 +157,7 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * For other PMDs and more info, refer to the ``MAINTAINERS`` file. * New external functions should be added to the local ``version.map`` file. - See the :doc:`Guidelines for ABI policy and versioning </contributing/versioning>`. + See the :doc:`Guidelines for ABI policy and versioning </contributing/abi_versioning>`. New external functions should also be added in alphabetical order. * Important changes will require an addition to the release notes in ``doc/guides/rel_notes/``.
doc/guides/contributing/versioning.rst deleted +0 -591
591 lines not on this page · raw message
doc/guides/rel_notes/deprecation.rst +1 -1
@@ -4,7 +4,7 @@ ABI and API Deprecation ======================= -See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`. +See the :doc:`guidelines document for details of the ABI policy </contributing/abi_versioning>`. API and ABI deprecation notices are to be posted here.
Signature · 1 line
2.7.4
Re: [dpdk-dev] [PATCH v8 1/4] doc: separate versioning.rst into version and policy
Quoted 4 lines · On Tue, 5 Nov 2019 15:24:15 +0000 Ray Kinsella <[email protected]> wrote:
Separate
versioning.rstinto abi versioning and abi policy guidance, in preparation for adding more detail to the abi policy.Signed-off-by Ray Kinsella <[email protected]>
Quoted 12 lines
--- doc/guides/contributing/abi_policy.rst | 167 ++++++++ doc/guides/contributing/abi_versioning.rst | 427 +++++++++++++++++++++ doc/guides/contributing/index.rst | 3 +- doc/guides/contributing/patches.rst | 2 +- doc/guides/contributing/versioning.rst | 591 ----------------------------- doc/guides/rel_notes/deprecation.rst | 2 +- 6 files changed, 598 insertions(+), 594 deletions(-) create mode 100644 doc/guides/contributing/abi_policy.rst create mode 100644 doc/guides/contributing/abi_versioning.rst delete mode 100644 doc/guides/contributing/versioning.rst
Re: [dpdk-dev] [PATCH v8 1/4] doc: separate versioning.rst into version and policy
In reply to Ray KinsellaQuoted 15 lines
-----Original Message-----
From: Ray Kinsella <[email protected]>
Sent: Tuesday, November 5, 2019 3:24 PM
To: [email protected]
Cc: [email protected]; [email protected]; [email protected]; Richardson, Bruce <[email protected]>; Yigit, Ferruh <[email protected]>; Ananyev, Konstantin <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: [PATCH v8 1/4] doc: separateversioning.rstinto version and policy
Quoted 3 lines
Separate
versioning.rstinto abi versioning and abi policy guidance, in preparation for adding more detail to the abi policy.
PATCH v8 2/4 doc: changes to abi policy introducing major abi versions
In reply to Ray KinsellaThis policy change introduces major ABI versions, these are declared every year, typically aligned with the LTS release and are supported by subsequent releases in the following year. This change is intended to improve ABI stabilty for those projects consuming DPDK.
--- doc/guides/contributing/abi_policy.rst | 319 ++++-- .../contributing/img/abi_stability_policy.svg | 1059 ++++++++++++++++++++ doc/guides/contributing/img/what_is_an_abi.svg | 382 +++++++ doc/guides/contributing/stable.rst | 12 +- 4 files changed, 1681 insertions(+), 91 deletions(-) create mode 100644 doc/guides/contributing/img/abi_stability_policy.svg create mode 100644 doc/guides/contributing/img/what_is_an_abi.svg
doc/guides/contributing/abi_policy.rst +236 -83
@@ -1,31 +1,44 @@ .. SPDX-License-Identifier: BSD-3-Clause - Copyright 2018 The DPDK contributors + Copyright 2019 The DPDK contributors -DPDK ABI/API policy -=================== +ABI Policy +========== Description ----------- -This document details some methods for handling ABI management in the DPDK. +This document details the management policy that ensures the long-term stability +of the DPDK ABI and API. General Guidelines ------------------ -#. Whenever possible, ABI should be preserved -#. ABI/API may be changed with a deprecation process -#. The modification of symbols can generally be managed with versioning -#. Libraries or APIs marked in ``experimental`` state may change without constraint -#. New APIs will be marked as ``experimental`` for at least one release to allow - any issues found by users of the new API to be fixed quickly -#. The addition of symbols is generally not problematic -#. The removal of symbols generally is an ABI break and requires bumping of the - LIBABIVER macro -#. Updates to the minimum hardware requirements, which drop support for hardware which - was previously supported, should be treated as an ABI change. - -What is an ABI -~~~~~~~~~~~~~~ +#. Major ABI versions are declared every **year** and are then supported for one + year, typically aligned with the :ref:`LTS release <stable_lts_releases>`. +#. The ABI version is managed at a project level in DPDK, with the ABI version + reflected in all library's soname. +#. The ABI should be preserved and not changed lightly. ABI changes must follow + the outlined :ref:`deprecation process <abi_changes>`. +#. The addition of symbols is generally not problematic. The modification of + symbols is managed with ABI Versioning. +#. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`, + once approved these will form part of the next ABI version. +#. Libraries or APIs marked as :ref:`Experimental <experimental_apis>` are not + considered part of an ABI version and may change without constraint. +#. Updates to the :ref:`minimum hardware requirements <hw_rqmts>`, which drop + support for hardware which was previously supported, should be treated as an + ABI change. + +.. note:: + + In 2019, the DPDK community stated its intention to move to ABI stable + 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. + +What is an ABI? +~~~~~~~~~~~~~~~ An ABI (Application Binary Interface) is the set of runtime interfaces exposed by a library. It is similar to an API (Application Programming Interface) but
@@ -37,30 +50,80 @@ Therefore, in the case of dynamic linking, it is critical that an ABI is preserved, or (when modified), done in such a way that the application is unable to behave improperly or in an unexpected fashion. +.. _figure_what_is_an_abi: + +.. figure:: img/what_is_an_abi.* + + Illustration of DPDK API and ABI. -ABI/API Deprecation -------------------- + +What is an ABI version? +~~~~~~~~~~~~~~~~~~~~~~~ + +An ABI version is an instance of a library's ABI at a specific release. Certain +releases are considered to be milestone releases, the yearly LTS release for +example. The ABI of a milestone release may be designated as a 'major ABI +version', where this ABI version is then supported for some number of subsequent +releases and is annotated in the library's soname. + +ABI version support in subsequent releases facilitates application upgrades, by +enabling applications built against the milestone release to upgrade to +subsequent releases of a library without a rebuild. + +More details on major ABI version can be found in the ABI Versioning guide. The DPDK ABI policy -~~~~~~~~~~~~~~~~~~~ +------------------- + +A major ABI version is declared every year, aligned with that year's LTS +release, e.g. v19.11. This ABI version is then supported for one year by all +subsequent releases within that time period, until the next LTS release, e.g. +v20.11. -ABI versions are set at the time of major release labeling, and the ABI may -change multiple times, without warning, between the last release label and the -HEAD label of the git tree. +At the declaration of a major ABI version, major version numbers encoded in +libraries' sonames are bumped to indicate the new version, with the minor +version reset to ``0``. An example would be ``librte_eal.so.20.3`` would become +``librte_eal.so.21.0``. -ABI versions, once released, are available until such time as their -deprecation has been noted in the Release Notes for at least one major release -cycle. For example consider the case where the ABI for DPDK 2.0 has been -shipped and then a decision is made to modify it during the development of -DPDK 2.1. The decision will be recorded in the Release Notes for the DPDK 2.1 -release and the modification will be made available in the DPDK 2.2 release. +The ABI may then change multiple times, without warning, between the last major +ABI version increment and the HEAD label of the git tree, with the condition +that ABI compatibility with the major ABI version is preserved and therefore +sonames do not change. -ABI versions may be deprecated in whole or in part as needed by a given -update. +Minor versions are incremented to indicate the release of a new ABI compatible +DPDK release, typically the DPDK quarterly releases. An example of this, might +be that ``librte_eal.so.20.1`` would indicate the first ABI compatible DPDK +release, following the declaration of the new major ABI version ``20``. -Some ABI changes may be too significant to reasonably maintain multiple -versions. In those cases ABI's may be updated without backward compatibility -being provided. The requirements for doing so are: +An ABI version is supported in all new releases until the next major ABI version +is declared. When changing the major ABI version, the release notes will detail +all ABI changes. + +.. _figure_abi_stability_policy: + +.. figure:: img/abi_stability_policy.* + + Mapping of new ABI versions and ABI version compatibility to DPDK releases. + +.. _abi_changes: + +ABI Changes +~~~~~~~~~~~ + +The ABI may still change after the declaration of a major ABI version, that is +new APIs may be still added or existing APIs may be modified. + +.. Warning:: + + Note that, this policy details the method by which the ABI may be changed, + with due regard to preserving compatibility and observing deprecation + notices. This process however should not be undertaken lightly, as a general + rule ABI stability is extremely important for downstream consumers of DPDK. + The ABI should only be changed for significant reasons, such as performance + enhancements. ABI breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided. + +The requirements for changing the ABI are: #. At least 3 acknowledgments of the need to do so must be made on the dpdk.org mailing list.
@@ -69,34 +132,119 @@ being provided. The requirements for doing so are: no maintainer is available for the component, the tree/sub-tree maintainer for that component must acknowledge the ABI change instead. + - The acknowledgment of three members of the technical board, as delegates + of the `technical board <https://core.dpdk.org/techboard/>`_ acknowledging + the need for the ABI change, is also mandatory. + - It is also recommended that acknowledgments from different "areas of interest" be sought for each deprecation, for example: from NIC vendors, CPU vendors, end-users, etc. -#. The changes (including an alternative map file) can be included with - deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, - to provide more details about oncoming changes. - ``RTE_NEXT_ABI`` wrapper will be removed when it become the default ABI. - More preferred way to provide this information is sending the feature - as a separate patch and reference it in deprecation notice. +#. Backward compatibility with the major ABI version must be maintained through + ABI Versioning, with :ref:`forward-only <forward-only>` compatibility + offered for any ABI changes that are indicated to be part of the next ABI + version. -#. A full deprecation cycle, as explained above, must be made to offer - downstream consumers sufficient warning of the change. + - In situations where backward compatibility is not possible, read the + section on :ref:`abi_breakages`. -Note that the above process for ABI deprecation should not be undertaken -lightly. ABI stability is extremely important for downstream consumers of the -DPDK, especially when distributed in shared object form. Every effort should -be made to preserve the ABI whenever possible. The ABI should only be changed -for significant reasons, such as performance enhancements. ABI breakage due to -changes such as reorganizing public structure fields for aesthetic or -readability purposes should be avoided. + - No backward or forward compatibility is offered for API changes marked as + ``experimental``, as described in the section on :ref:`Experimental APIs + and Libraries <experimental_apis>`. -.. note:: +#. If a newly proposed API functionally replaces an existing one, when the new + API becomes non-experimental, then the old one is marked with + ``__rte_deprecated``. + + - The depreciated API should follow the notification process to be removed, + see :ref:`deprecation_notices`. + + - At the declaration of the next major ABI version, those ABI changes then + become a formal part of the new ABI and the requirement to preserve ABI + compatibility with the last major ABI version is then dropped. + + - The responsibility for removing redundant ABI compatibility code rests + with the original contributor of the ABI changes, failing that, then with + the contributor's company and then finally with the maintainer. + +.. _forward-only: + +.. Note:: + + Note that forward-only compatibility is offered for those changes made + between major ABI versions. As a library's soname can only describe + compatibility with the last major ABI version, until the next major ABI + version is declared, these changes therefore cannot be resolved as a runtime + dependency through the soname. Therefore any application wishing to make use + of these ABI changes can only ensure that its runtime dependencies are met + through Operating System package versioning. + +.. _hw_rqmts: + +.. Note:: Updates to the minimum hardware requirements, which drop support for hardware which was previously supported, should be treated as an ABI change, and - follow the relevant deprecation policy procedures as above: 3 acks and - announcement at least one release in advance. + follow the relevant deprecation policy procedures as above: 3 acks, technical + board approval and announcement at least one release in advance. + +.. _abi_breakages: + +ABI Breakages +~~~~~~~~~~~~~ + +For those ABI changes that are too significant to reasonably maintain multiple +symbol versions, there is an amended process. In these cases, ABIs may be +updated without the requirement of backward compatibility being provided. These +changes must follow the same process :ref:`described above <abi_changes>` as non-breaking +changes, however with the following additional requirements: + +#. ABI breaking changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, to provide + more details about oncoming changes. ``RTE_NEXT_ABI`` wrapper will be removed + at the declaration of the next major ABI version. + +#. Once approved, and after the deprecation notice has been observed these + changes will form part of the next declared major ABI version. + +Examples of ABI Changes +~~~~~~~~~~~~~~~~~~~~~~~ + +The following are examples of allowable ABI changes occurring between +declarations of major ABI versions. + +* DPDK 19.11 release, defines the function ``rte_foo()``, and ``rte_foo()`` + as part of the major ABI version ``20``. + +* DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and + this is not a problem as long as the symbol ``rte_foo@DPDK20`` is + preserved through ABI Versioning. + + - The new function may be marked with the ``__rte_experimental`` tag for a + number of releases, as described in the section :ref:`experimental_apis`. + + - Once ``rte_foo(uint8_t bar)`` becomes non-experimental ``rte_foo()`` is then + declared as ``__rte_depreciated``, with an associated deprecation notice + provided. + +* DPDK 19.11 is not re-released to include ``rte_foo(uint8_t bar)``, the new + version of ``rte_foo`` only exists from DPDK 20.02 onwards as described in the + :ref:`note on forward-only compatibility<forward-only>`. + +* DPDK 20.02 release defines the experimental function ``__rte_experimental + rte_baz()``. This function may or may not exist in the DPDK 20.05 release. + +* An application ``dPacket`` wishes to use ``rte_foo(uint8_t bar)``, before the + declaration of the DPDK ``21`` major API version. The application can only + ensure its runtime dependencies are met by specifying ``DPDK (>= 20.2)`` as + an explicit package dependency, as the soname only may only indicate the + supported major ABI version. + +* At the release of DPDK 20.11, the function ``rte_foo(uint8_t bar)`` becomes + formally part of then new major ABI version DPDK 21.0 and ``rte_foo()`` may be + removed. + +.. _deprecation_notices: Examples of Deprecation Notices ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -104,46 +252,42 @@ Examples of Deprecation Notices The following are some examples of ABI deprecation notices which would be added to the Release Notes: -* The Macro ``#RTE_FOO`` is deprecated and will be removed with version 2.0, - to be replaced with the inline function ``rte_foo()``. +* The Macro ``#RTE_FOO`` is deprecated and will be removed with ABI version + 21, to be replaced with the inline function ``rte_foo()``. * The function ``rte_mbuf_grok()`` has been updated to include a new parameter - in version 2.0. Backwards compatibility will be maintained for this function - until the release of version 2.1 + in version 20.2. Backwards compatibility will be maintained for this function + until the release of the new DPDK major ABI version 21, in DPDK version + 20.11. -* The members of ``struct rte_foo`` have been reorganized in release 2.0 for +* The members of ``struct rte_foo`` have been reorganized in DPDK 20.02 for performance reasons. Existing binary applications will have backwards - compatibility in release 2.0, while newly built binaries will need to - reference the new structure variant ``struct rte_foo2``. Compatibility will - be removed in release 2.2, and all applications will require updating and + compatibility in release 20.02, while newly built binaries will need to + reference the new structure variant ``struct rte_foo2``. Compatibility will be + removed in release 20.11, and all applications will require updating and rebuilding to the new structure at that time, which will be renamed to the original ``struct rte_foo``. * Significant ABI changes are planned for the ``librte_dostuff`` library. The - upcoming release 2.0 will not contain these changes, but release 2.1 will, + upcoming release 20.02 will not contain these changes, but release 20.11 will, and no backwards compatibility is planned due to the extensive nature of - these changes. Binaries using this library built prior to version 2.1 will + these changes. Binaries using this library built prior to ABI version 21 will require updating and recompilation. -New API replacing previous one -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If a new API proposed functionally replaces an existing one, when the new API -becomes non-experimental then the old one is marked with ``__rte_deprecated``. -Deprecated APIs are removed completely just after the next LTS. +.. _experimental_apis: -Reminder that old API should follow deprecation process to be removed. +Experimental +------------ +APIs +~~~~ -Experimental APIs ------------------ - -APIs marked as ``experimental`` are not considered part of the ABI and may -change without warning at any time. Since changes to APIs are most likely -immediately after their introduction, as users begin to take advantage of -those new APIs and start finding issues with them, new DPDK APIs will be -automatically marked as ``experimental`` to allow for a period of stabilization -before they become part of a tracked ABI. +APIs marked as ``experimental`` are not considered part of an ABI version and +may change without warning at any time. Since changes to APIs are most likely +immediately after their introduction, as users begin to take advantage of those +new APIs and start finding issues with them, new DPDK APIs will be automatically +marked as ``experimental`` to allow for a period of stabilization before they +become part of a tracked ABI version. Note that marking an API as experimental is a multi step process. To mark an API as experimental, the symbols which are desired to be exported
@@ -161,7 +305,16 @@ In addition to tagging the code with ``__rte_experimental``, the doxygen markup must also contain the EXPERIMENTAL string, and the MAINTAINERS file should note the EXPERIMENTAL libraries. -For removing the experimental tag associated with an API, deprecation notice -is not required. Though, an API should remain in experimental state for at least -one release. Thereafter, normal process of posting patch for review to mailing -list can be followed. +For removing the experimental tag associated with an API, deprecation notice is +not required. Though, an API should remain in experimental state for at least +one release. Thereafter, the normal process of posting patch for review to +mailing list can be followed. + +Libraries +~~~~~~~~~ + +Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library.
doc/guides/contributing/img/abi_stability_policy.svg new file +1059 -0
1,060 lines not on this page · raw message
doc/guides/contributing/img/what_is_an_abi.svg new file +382 -0
383 lines not on this page · raw message
doc/guides/contributing/stable.rst +4 -8
@@ -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 ==========================================
@@ -53,6 +53,9 @@ 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. +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 longer depending on the number and criticality of the backported
@@ -119,10 +122,3 @@ A Stable Release will be released by: list. Stable releases are available on the `dpdk.org download page <http://core.dpdk.org/download/>`_. - - -ABI ---- - -The Stable Release should not be seen as a way of breaking or circumventing -the DPDK ABI policy.
Signature · 1 line
2.7.4
Quoted 7 lines · On Tue, 5 Nov 2019 15:24:16 +0000 Ray Kinsella <[email protected]> wrote:
This policy change introduces major ABI versions, these are declared every year, typically aligned with the LTS release and are supported by subsequent releases in the following year. This change is intended to improve ABI stabilty for those projects consuming DPDK.
Signed-off-by Ray Kinsella <[email protected]>
I'm sorry I still have some comments.
But on the positive side, you can see that I carefuly read this doc.
05/11/2019 16:24, Ray Kinsella:
doc/guides/contributing/abi_policy.rst line 17
Quoted 2 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. Major ABI versions are declared every **year** and are then supported for one + year, typically aligned with the :ref:`LTS release <stable_lts_releases>`.
As discussed earlier, a major ABI version can be declared less often
than one year in the future.
An ABI is supported more than one year, because of the LTS branches. That's why I propose to replace with this sentence:
"
Major ABI versions are declared regularly and are then supported for
at least one year, typically aligned with the :ref:LTS release <stable_lts_releases>. "
doc/guides/contributing/abi_policy.rst line 19
Quoted 2 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. The ABI version is managed at a project level in DPDK, with the ABI version + reflected in all library's soname.
Yes, even the experimental libraries should have the same version, with the minor number incremented at each release. (just a comment to change a policy at the end of this patch)
doc/guides/contributing/abi_policy.rst line 38
Quoted 5 lines
doc/guides/contributing/abi_policy.rst +5
-0+ In 2019, the DPDK community stated its intention to move to ABI stable + 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.
Great, the schedule is clear here.
doc/guides/contributing/abi_policy.rst Therefore, in the case of dynamic linking, it is critical that an ABI is · line 81
Quoted 4 lines
doc/guides/contributing/abi_policy.rst +4
-0+A major ABI version is declared every year, aligned with that year's LTS +release, e.g. v19.11. This ABI version is then supported for one year by all +subsequent releases within that time period, until the next LTS release, e.g. +v20.11.
Let's reword like this:
"
A new major ABI version can be declared when a new LTS branch is started, e.g. ABI 19 for DPDK 19.11.0.
This major ABI version is then supported until the next one, e.g. ABI 20 for DPDK 20.11.0.
All ABI changes must be detailed in the release notes.
"
doc/guides/contributing/abi_policy.rst Therefore, in the case of dynamic linking, it is critical that an ABI is
Quoted 12 lines
doc/guides/contributing/abi_policy.rst +10
-0+At the declaration of a major ABI version, major version numbers encoded in +libraries' sonames are bumped to indicate the new version, with the minor +version reset to ``0``. An example would be ``librte_eal.so.20.3`` would become +``librte_eal.so.21.0``. +Minor versions are incremented to indicate the release of a new ABI compatible +DPDK release, typically the DPDK quarterly releases. An example of this, might +be that ``librte_eal.so.20.1`` would indicate the first ABI compatible DPDK +release, following the declaration of the new major ABI version ``20``. +An ABI version is supported in all new releases until the next major ABI version +is declared.
This sentence is repetitive.
Quoted 2 lines
When changing the major ABI version, the release notes will detail +all ABI changes.
I suggest to move and reword this sentence above (as in my above reword).
Review
Quoted 2 lines
(quoted diff) +2
-0+ ABI breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided.
Why it should be avoided?
If the ABI is broken anyway, I don't see any reason to not break it more.
doc/guides/contributing/abi_policy.rst being provided. The requirements for doing so are: · line 205
Quoted 4 lines
doc/guides/contributing/abi_policy.rst +4
-0+#. ABI breaking changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, to provide + more details about oncoming changes. ``RTE_NEXT_ABI`` wrapper will be removed + at the declaration of the next major ABI version.
I missed that in discussions.
I thought we wanted to wait for the next major ABI. If we allow NEXT_ABI ifdef, we will have 2 DPDK versions (stable and next ABI) to test.
doc/guides/contributing/abi_policy.rst In addition to tagging the code with ``__rte_experimental``, · line 320
Quoted 5 lines
doc/guides/contributing/abi_policy.rst +5
-0+Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library.
It means not all libraries will have the same ABI version. It is contrary of "ABI version is managed at a project level", and I don't see a real benefit of a different version number. Anyway, some experimental functions can live inside a library with a stable ABI version number.
Quoted 2 lines · Thomas Monjalon
I'm sorry I still have some comments.
But on the positive side, you can see that I carefuly read this doc.
no worries.
Quoted 5 lines
05/11/2019 16:24, Ray Kinsella:
doc/guides/contributing/abi_policy.rst line 17
Quoted 2 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. Major ABI versions are declared every **year** and are then supported for one + year, typically aligned with the :ref:`LTS release <stable_lts_releases>`.
Quoted 8 lines
As discussed earlier, a major ABI version can be declared less often
than one year in the future.
An ABI is supported more than one year, because of the LTS branches. That's why I propose to replace with this sentence:
"
Major ABI versions are declared regularly and are then supported for
at least one year, typically aligned with the :ref:LTS release <stable_lts_releases>. "
So look, this one was a decision of the technical board.
My position is still what was agreed was, "declared every year, and supported for one year". I like it, it's crystal clear what is the policy, until we change the policy.
That said, I can make the change no problem, but I need some others to chime in to ok it. Perhaps at the head of the Techboard today?
Quoted 7 lines
doc/guides/contributing/abi_policy.rst line 19
Quoted 3 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. The ABI version is managed at a project level in DPDK, with the ABI version + reflected in all library's soname.Yes, even the experimental libraries should have the same version, with the minor number incremented at each release. (just a comment to change a policy at the end of this patch)
It's described elsewhere in the document, experimental libraries have a major ABI version of 0, to indicate they exist outside of ABI management. Minor number then changes as the experimental library changes as before.
Quoted 9 lines
doc/guides/contributing/abi_policy.rst line 38
Quoted 6 lines
doc/guides/contributing/abi_policy.rst +5
-0+ In 2019, the DPDK community stated its intention to move to ABI stable + 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.Great, the schedule is clear here.
Quoted 13 lines
doc/guides/contributing/abi_policy.rst Therefore, in the case of dynamic linking, it is critical that an ABI is · line 81
Quoted 4 lines
doc/guides/contributing/abi_policy.rst +4
-0+A major ABI version is declared every year, aligned with that year's LTS +release, e.g. v19.11. This ABI version is then supported for one year by all +subsequent releases within that time period, until the next LTS release, e.g. +v20.11.Let's reword like this:
"
A new major ABI version can be declared when a new LTS branch is started, e.g. ABI 19 for DPDK 19.11.0.
This major ABI version is then supported until the next one, e.g. ABI 20 for DPDK 20.11.0.
All ABI changes must be detailed in the release notes.
"
This is more ambiguous, although what I said above stands.
If there is general agreement with changing this part of the policy, I am ok to make the change.
Quoted 11 lines
Quoted 11 lines
doc/guides/contributing/abi_policy.rst +8
-0+At the declaration of a major ABI version, major version numbers encoded in +libraries' sonames are bumped to indicate the new version, with the minor +version reset to ``0``. An example would be ``librte_eal.so.20.3`` would become +``librte_eal.so.21.0``. +Minor versions are incremented to indicate the release of a new ABI compatible +DPDK release, typically the DPDK quarterly releases. An example of this, might +be that ``librte_eal.so.20.1`` would indicate the first ABI compatible DPDK +release, following the declaration of the new major ABI version ``20``.
Quoted 4 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+An ABI version is supported in all new releases until the next major ABI version +is declared.This sentence is repetitive.
ACK
Quoted 4 lines
Quoted 2 lines
When changing the major ABI version, the release notes will detail +all ABI changes.
I suggest to move and reword this sentence above (as in my above reword).
ACK
Quoted 6 lines
Review
Quoted 3 lines
(quoted diff) +2
-0+ ABI breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided.Why it should be avoided?
If the ABI is broken anyway, I don't see any reason to not break it more.
This is text from the original ABI Policy - I think the general sentiment still stands. Just because you have an ABI Breakage window doesn't mean you should feel free to break the ABI. The 3 ACKs required from Technical Board member to change the ABI, are another reflection of this.
As a general rule.
Unnecessary changes should still be avoided, to reduce ABI churn between ABI versions.
Quoted 9 lines
doc/guides/contributing/abi_policy.rst being provided. The requirements for doing so are: · line 205
Quoted 4 lines
doc/guides/contributing/abi_policy.rst +4
-0+#. ABI breaking changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, to provide + more details about oncoming changes. ``RTE_NEXT_ABI`` wrapper will be removed + at the declaration of the next major ABI version.I missed that in discussions.
I thought we wanted to wait for the next major ABI. If we allowNEXT_ABIifdef, we will have 2 DPDK versions (stable and next ABI) to test.
This is text from the original ABI Policy - the purpose remains the same.
If you add an ABI breaking change in say 20.02, that clearly can't see the light of day until 20.11
You may still opt to prepare the community for the change, by putting your code out wrapped in a NEXT_ABI and flagging it. You then get the option for people, so inclined, to build and try your code.
I can't see it being used often, but it is another tool in the box of managing ABI change.
Quoted 10 lines
doc/guides/contributing/abi_policy.rst In addition to tagging the code with ``__rte_experimental``, · line 320
Quoted 6 lines
doc/guides/contributing/abi_policy.rst +5
-0+Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library.It means not all libraries will have the same ABI version. It is contrary of "ABI version is managed at a project level", and I don't see a real benefit of a different version number.
There is a benefit, major version 0 is a very clear indication that the library exists outside of ABI management.
A library isn't in the ABI, until it is in the ABI - an then it gets added to the major version number.
Quoted 2 lines
Anyway, some experimental functions can live inside a library with a stable ABI version number
True, but if an entire library is experimental - let's be crystal clear about that.
06/11/2019 09:49, Ray Kinsella:
Quoted 14 lines · Thomas Monjalon
Quoted 4 lines
05/11/2019 16:24, Ray Kinsella:
doc/guides/contributing/abi_policy.rst line 17
Quoted 2 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. Major ABI versions are declared every **year** and are then supported for one + year, typically aligned with the :ref:`LTS release <stable_lts_releases>`.Quoted 8 lines
As discussed earlier, a major ABI version can be declared less often
than one year in the future.
An ABI is supported more than one year, because of the LTS branches. That's why I propose to replace with this sentence:
"
Major ABI versions are declared regularly and are then supported for
at least one year, typically aligned with the :ref:LTS release <stable_lts_releases>. "
Quoted 1 line
So look, this one was a decision of the technical board.
The techboard didn't decide to change the ABI every year.
We decided to review the duration after the first year, with a plan to extend.
Quoted 2 lines
My position is still what was agreed was, "declared every year, and supported for one year". I like it, it's crystal clear what is the policy, until we change the policy.
I think it gives a wrong message.
Quoted 2 lines
That said, I can make the change no problem, but I need some others to chime in to ok it. Perhaps at the head of the Techboard today?
Yes I add it to the techboard meeting.
Quoted 10 lines
Quoted 6 lines
doc/guides/contributing/abi_policy.rst line 19
Quoted 2 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. The ABI version is managed at a project level in DPDK, with the ABI version + reflected in all library's soname.Yes, even the experimental libraries should have the same version, with the minor number incremented at each release. (just a comment to change a policy at the end of this patch)
It's described elsewhere in the document, experimental libraries have a major ABI version of 0, to indicate they exist outside of ABI management. Minor number then changes as the experimental library changes as before.
Yes, but you cannot say "reflected in all library's soname".
Quoted 22 lines
Quoted 8 lines
doc/guides/contributing/abi_policy.rst line 38
Quoted 5 lines
doc/guides/contributing/abi_policy.rst +5
-0+ In 2019, the DPDK community stated its intention to move to ABI stable + 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.Great, the schedule is clear here.
Quoted 13 lines
doc/guides/contributing/abi_policy.rst Therefore, in the case of dynamic linking, it is critical that an ABI is · line 81
Quoted 4 lines
doc/guides/contributing/abi_policy.rst +4
-0+A major ABI version is declared every year, aligned with that year's LTS +release, e.g. v19.11. This ABI version is then supported for one year by all +subsequent releases within that time period, until the next LTS release, e.g. +v20.11.Let's reword like this:
"
A new major ABI version can be declared when a new LTS branch is started, e.g. ABI 19 for DPDK 19.11.0.
This major ABI version is then supported until the next one, e.g. ABI 20 for DPDK 20.11.0.
All ABI changes must be detailed in the release notes.
"
Quoted 1 line
This is more ambiguous, although what I said above stands.
What you said is wrong because of 2 reasons:
- it is not always one year for an major ABI
- it is always longer because of LTS branch
Quoted 2 lines
If there is general agreement with changing this part of the policy, I am ok to make the change.
Yes let's review with the techboard.
Quoted 6 lines
Quoted 5 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+ ABI breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided.Why it should be avoided?
If the ABI is broken anyway, I don't see any reason to not break it more.
Quoted 7 lines
This is text from the original ABI Policy - I think the general sentiment still stands. Just because you have an ABI Breakage window doesn't mean you should feel free to break the ABI. The 3 ACKs required from Technical Board member to change the ABI, are another reflection of this.
As a general rule.
Unnecessary changes should still be avoided, to reduce ABI churn between ABI versions.
I agree we must avoid unnecessary API changes because it requires apps to adapt. But if the change is only ABI, and we are in an ABI-change window, I don't see any issue.
Quoted 10 lines
Quoted 9 lines
doc/guides/contributing/abi_policy.rst being provided. The requirements for doing so are: · line 205
Quoted 4 lines
doc/guides/contributing/abi_policy.rst +4
-0+#. ABI breaking changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, to provide + more details about oncoming changes. ``RTE_NEXT_ABI`` wrapper will be removed + at the declaration of the next major ABI version.I missed that in discussions.
I thought we wanted to wait for the next major ABI. If we allowNEXT_ABIifdef, we will have 2 DPDK versions (stable and next ABI) to test.
Quoted 7 lines
This is text from the original ABI Policy - the purpose remains the same.
If you add an ABI breaking change in say 20.02, that clearly can't see the light of day until 20.11You may still opt to prepare the community for the change, by putting your code out wrapped in a
NEXT_ABIand flagging it. You then get the option for people, so inclined, to build and try your code.I can't see it being used often, but it is another tool in the box of managing ABI change.
OK, let's keep this tool.
Quoted 15 lines
Quoted 9 lines
doc/guides/contributing/abi_policy.rst In addition to tagging the code with ``__rte_experimental``, · line 320
Quoted 5 lines
doc/guides/contributing/abi_policy.rst +5
-0+Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library.It means not all libraries will have the same ABI version. It is contrary of "ABI version is managed at a project level", and I don't see a real benefit of a different version number.
There is a benefit, major version 0 is a very clear indication that the library exists outside of ABI management.
A library isn't in the ABI, until it is in the ABI - an then it gets added to the major version number.
Quoted 5 lines
Quoted 2 lines
Anyway, some experimental functions can live inside a library with a stable ABI version number
True, but if an entire library is experimental - let's be crystal clear about that.
I would like to see what others think.
Quoted 10 lines · Thomas Monjalon
Quoted 10 lines
Quoted 9 lines
doc/guides/contributing/abi_policy.rst In addition to tagging the code with ``__rte_experimental``, · line 320
Quoted 5 lines
doc/guides/contributing/abi_policy.rst +5
-0+Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library.It means not all libraries will have the same ABI version. It is contrary of "ABI version is managed at a project level", and I don't see a real benefit of a different version number.
Quoted 4 lines
Quoted 4 lines
There is a benefit, major version 0 is a very clear indication that the library exists outside of ABI management.
A library isn't in the ABI, until it is in the ABI - an then it gets added to the major version number.
The user must already set ALLOW_EXPERIMENTAL_API when using api from such a library.
This is visible to him when developping.
On the contrary a 0 ABIVER is an (almost) internal thing.
Quoted 6 lines
Quoted 6 lines
Quoted 3 lines
Anyway, some experimental functions can live inside a library with a stable ABI version number
True, but if an entire library is experimental - let's be crystal clear about that.
Having this special case means that the library soname will contain a .0. Won't it prevent us from having two versions of dpdk installed?
Signature · 1 line
David Marchand
Quoted 37 lines · Thomas Monjalon
06/11/2019 09:49, Ray Kinsella:
Quoted 14 lines · Thomas Monjalon
Quoted 4 lines
05/11/2019 16:24, Ray Kinsella:
doc/guides/contributing/abi_policy.rst line 17
Quoted 2 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. Major ABI versions are declared every **year** and are then supported for one + year, typically aligned with the :ref:`LTS release <stable_lts_releases>`.Quoted 8 lines
As discussed earlier, a major ABI version can be declared less often
than one year in the future.
An ABI is supported more than one year, because of the LTS branches. That's why I propose to replace with this sentence:
"
Major ABI versions are declared regularly and are then supported for
at least one year, typically aligned with the :ref:LTS release <stable_lts_releases>. "Quoted 1 line
So look, this one was a decision of the technical board.
The techboard didn't decide to change the ABI every year.
We decided to review the duration after the first year, with a plan to extend.Quoted 2 lines
My position is still what was agreed was, "declared every year, and supported for one year". I like it, it's crystal clear what is the policy, until we change the policy.
I think it gives a wrong message.
Quoted 2 lines
That said, I can make the change no problem, but I need some others to chime in to ok it. Perhaps at the head of the Techboard today?
Yes I add it to the techboard meeting.
Quoted 7 lines
Quoted 6 lines
doc/guides/contributing/abi_policy.rst line 19
Quoted 2 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. The ABI version is managed at a project level in DPDK, with the ABI version + reflected in all library's soname.Yes, even the experimental libraries should have the same version, with the minor number incremented at each release. (just a comment to change a policy at the end of this patch)
Quoted 5 lines
Quoted 3 lines
It's described elsewhere in the document, experimental libraries have a major ABI version of 0, to indicate they exist outside of ABI management. Minor number then changes as the experimental library changes as before.
Yes, but you cannot say "reflected in all library's soname".
ACK - I will clarify
Quoted 23 lines
Quoted 23 lines
Quoted 22 lines
doc/guides/contributing/abi_policy.rst line 38
Quoted 6 lines
doc/guides/contributing/abi_policy.rst +5
-0+ In 2019, the DPDK community stated its intention to move to ABI stable + 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.Great, the schedule is clear here.
doc/guides/contributing/abi_policy.rst Therefore, in the case of dynamic linking, it is critical that an ABI is · line 81
Quoted 4 lines
doc/guides/contributing/abi_policy.rst +4
-0+A major ABI version is declared every year, aligned with that year's LTS +release, e.g. v19.11. This ABI version is then supported for one year by all +subsequent releases within that time period, until the next LTS release, e.g. +v20.11.Let's reword like this:
"
A new major ABI version can be declared when a new LTS branch is started, e.g. ABI 19 for DPDK 19.11.0.
This major ABI version is then supported until the next one, e.g. ABI 20 for DPDK 20.11.0.
All ABI changes must be detailed in the release notes.
"
Quoted 4 lines
Quoted 1 line
This is more ambiguous, although what I said above stands.
What you said is wrong because of 2 reasons:
- it is not always one year for an major ABI
Well that is a point of disagreement.
Quoted 1 line
- it is always longer because of LTS branch
Well I was pretty careful to qualify the ABI policy applies to releases over the year. To distinguish it from LTS branch.
Quoted 67 lines
Quoted 3 lines
If there is general agreement with changing this part of the policy, I am ok to make the change.
Yes let's review with the techboard.
Quoted 6 lines
Quoted 5 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+ ABI breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided.Why it should be avoided?
If the ABI is broken anyway, I don't see any reason to not break it more.Quoted 7 lines
This is text from the original ABI Policy - I think the general sentiment still stands. Just because you have an ABI Breakage window doesn't mean you should feel free to break the ABI. The 3 ACKs required from Technical Board member to change the ABI, are another reflection of this.
As a general rule.
Unnecessary changes should still be avoided, to reduce ABI churn between ABI versions.I agree we must avoid unnecessary API changes because it requires apps to adapt. But if the change is only ABI, and we are in an ABI-change window, I don't see any issue>
Quoted 10 lines
Quoted 9 lines
doc/guides/contributing/abi_policy.rst being provided. The requirements for doing so are: · line 205
Quoted 4 lines
doc/guides/contributing/abi_policy.rst +4
-0+#. ABI breaking changes (including an alternative map file) can be included with + deprecation notice, in wrapped way by the ``RTE_NEXT_ABI`` option, to provide + more details about oncoming changes. ``RTE_NEXT_ABI`` wrapper will be removed + at the declaration of the next major ABI version.I missed that in discussions.
I thought we wanted to wait for the next major ABI. If we allowNEXT_ABIifdef, we will have 2 DPDK versions (stable and next ABI) to test.Quoted 7 lines
This is text from the original ABI Policy - the purpose remains the same.
If you add an ABI breaking change in say 20.02, that clearly can't see the light of day until 20.11You may still opt to prepare the community for the change, by putting your code out wrapped in a
NEXT_ABIand flagging it. You then get the option for people, so inclined, to build and try your code.I can't see it being used often, but it is another tool in the box of managing ABI change.
OK, let's keep this tool.
Quoted 15 lines
Quoted 9 lines
doc/guides/contributing/abi_policy.rst In addition to tagging the code with ``__rte_experimental``, · line 320
Quoted 5 lines
doc/guides/contributing/abi_policy.rst +5
-0+Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library.It means not all libraries will have the same ABI version. It is contrary of "ABI version is managed at a project level", and I don't see a real benefit of a different version number.
There is a benefit, major version 0 is a very clear indication that the library exists outside of ABI management.
A library isn't in the ABI, until it is in the ABI - an then it gets added to the major version number.Quoted 5 lines
Quoted 2 lines
Anyway, some experimental functions can live inside a library with a stable ABI version number
True, but if an entire library is experimental - let's be crystal clear about that.
I would like to see what others think.
Hi,
Please find the techboard comments below.
06/11/2019 10:22, Ray Kinsella:
Quoted 24 lines · Thomas Monjalon
Quoted 23 lines
06/11/2019 09:49, Ray Kinsella:
Quoted 14 lines · Thomas Monjalon
Quoted 4 lines
05/11/2019 16:24, Ray Kinsella:
doc/guides/contributing/abi_policy.rst line 17
Quoted 2 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. Major ABI versions are declared every **year** and are then supported for one + year, typically aligned with the :ref:`LTS release <stable_lts_releases>`.Quoted 8 lines
As discussed earlier, a major ABI version can be declared less often
than one year in the future.
An ABI is supported more than one year, because of the LTS branches. That's why I propose to replace with this sentence:
"
Major ABI versions are declared regularly and are then supported for
at least one year, typically aligned with the :ref:LTS release <stable_lts_releases>. "Quoted 1 line
So look, this one was a decision of the technical board.
The techboard didn't decide to change the ABI every year.
We decided to review the duration after the first year, with a plan to extend.Quoted 2 lines
My position is still what was agreed was, "declared every year, and supported for one year". I like it, it's crystal clear what is the policy, until we change the policy.
Quoted 6 lines
Quoted 6 lines
I think it gives a wrong message.
Quoted 2 lines
That said, I can make the change no problem, but I need some others to chime in to ok it. Perhaps at the head of the Techboard today?
Yes I add it to the techboard meeting.
The techboard propose other rewords:
"supported" may be replaced with "compatibility is enforced" "every year" may be replaced with "no more frequently than every year" "declared" may be replaced with "could be declared"
I think you got the idea. Please adjust wording to something more accurate.
###
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
doc/guides/contributing/abi_policy.rst Therefore, in the case of dynamic linking, it is critical that an ABI is · line 81
Quoted 4 lines
doc/guides/contributing/abi_policy.rst +4
-0+A major ABI version is declared every year, aligned with that year's LTS +release, e.g. v19.11. This ABI version is then supported for one year by all +subsequent releases within that time period, until the next LTS release, e.g. +v20.11.Let's reword like this:
"
A new major ABI version can be declared when a new LTS branch is started,
It has been suggested to replace "can" with "may".
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
e.g. ABI 19 for DPDK 19.11.0.
This major ABI version is then supported until the next one, e.g. ABI 20 for DPDK 20.11.0.
All ABI changes must be detailed in the release notes. "
My reword is wrong because ABI versions should be 20 and 21 respectively.
Quoted 6 lines
Quoted 4 lines
Quoted 1 line
This is more ambiguous, although what I said above stands.
What you said is wrong because of 2 reasons:
- it is not always one year for an major ABIWell that is a point of disagreement.
The techboard agreed to remove "every year".
Quoted 5 lines
Quoted 2 lines
- it is always longer because of LTS branch
Well I was pretty careful to qualify the ABI policy applies to releases over the year. To distinguish it from LTS branch.
As above, we may replace "ABI is supported" with
"ABI compatibility is enforced".
Quoted 4 lines
Quoted 4 lines
Quoted 2 lines
If there is general agreement with changing this part of the policy, I am ok to make the change.
Yes let's review with the techboard.
Please try to reflect techboard comments while keeping something understandable :)
###
Quoted 11 lines
Quoted 11 lines
Quoted 11 lines
Quoted 5 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+ ABI breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided.Why it should be avoided?
If the ABI is broken anyway, I don't see any reason to not break it more.This is text from the original ABI Policy - I think the general sentiment still stands. Just because you have an ABI Breakage window doesn't mean you should feel free to break the ABI. The 3 ACKs required from Technical Board member to change the ABI, are another reflection of this.
Quoted 6 lines
Quoted 6 lines
Quoted 2 lines
As a general rule.
Unnecessary changes should still be avoided, to reduce ABI churn between ABI versions.I agree we must avoid unnecessary API changes because it requires apps to adapt. But if the change is only ABI, and we are in an ABI-change window, I don't see any issue
The techboard agrees that the ABI changes are unlimited but API changes must be avoided. It is suggested to replace "ABI" with "API". I think this reword is better:
"
API changes such as reorganizing public structure fields
for aesthetic or readability purposes should be avoided.
"
###
Quoted 15 lines
Quoted 15 lines
Quoted 15 lines
Quoted 9 lines
doc/guides/contributing/abi_policy.rst In addition to tagging the code with ``__rte_experimental``, · line 320
Quoted 5 lines
doc/guides/contributing/abi_policy.rst +5
-0+Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library.It means not all libraries will have the same ABI version. It is contrary of "ABI version is managed at a project level", and I don't see a real benefit of a different version number.
There is a benefit, major version 0 is a very clear indication that the library exists outside of ABI management.
A library isn't in the ABI, until it is in the ABI - an then it gets added to the major version number.
Quoted 7 lines
Quoted 7 lines
Quoted 5 lines
Quoted 2 lines
Anyway, some experimental functions can live inside a library with a stable ABI version number
True, but if an entire library is experimental - let's be crystal clear about that.
I would like to see what others think.
The techboard decided to keep this policy: .0 for pure experimental libs.
Quoted 35 lines · Thomas Monjalon
Hi,
Please find the techboard comments below.06/11/2019 10:22, Ray Kinsella:
Quoted 24 lines · Thomas Monjalon
Quoted 23 lines
06/11/2019 09:49, Ray Kinsella:
Quoted 14 lines · Thomas Monjalon
Quoted 4 lines
05/11/2019 16:24, Ray Kinsella:
doc/guides/contributing/abi_policy.rst line 17
Quoted 2 lines
doc/guides/contributing/abi_policy.rst +2
-0+#. Major ABI versions are declared every **year** and are then supported for one + year, typically aligned with the :ref:`LTS release <stable_lts_releases>`.Quoted 8 lines
As discussed earlier, a major ABI version can be declared less often
than one year in the future.
An ABI is supported more than one year, because of the LTS branches. That's why I propose to replace with this sentence:
"
Major ABI versions are declared regularly and are then supported for
at least one year, typically aligned with the :ref:LTS release <stable_lts_releases>. "Quoted 1 line
So look, this one was a decision of the technical board.
The techboard didn't decide to change the ABI every year.
We decided to review the duration after the first year, with a plan to extend.Quoted 2 lines
My position is still what was agreed was, "declared every year, and supported for one year". I like it, it's crystal clear what is the policy, until we change the policy.
Quoted 6 lines
Quoted 6 lines
I think it gives a wrong message.
Quoted 2 lines
That said, I can make the change no problem, but I need some others to chime in to ok it. Perhaps at the head of the Techboard today?
Yes I add it to the techboard meeting.
Quoted 8 lines
The techboard propose other rewords:
"supported" may be replaced with "compatibility is enforced" "every year" may be replaced with "no more frequently than every year" "declared" may be replaced with "could be declared"I think you got the idea. Please adjust wording to something more accurate.
###
ACK - done in v9
Quoted 11 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
doc/guides/contributing/abi_policy.rst Therefore, in the case of dynamic linking, it is critical that an ABI is · line 81
Quoted 5 lines
doc/guides/contributing/abi_policy.rst +4
-0+A major ABI version is declared every year, aligned with that year's LTS +release, e.g. v19.11. This ABI version is then supported for one year by all +subsequent releases within that time period, until the next LTS release, e.g. +v20.11.Let's reword like this:
"
A new major ABI version can be declared when a new LTS branch is started,It has been suggested to replace "can" with "may".
ACK - I loosened the wording as described above "no more frequently than every year" etc in v9
Quoted 8 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
e.g. ABI 19 for DPDK 19.11.0.
This major ABI version is then supported until the next one, e.g. ABI 20 for DPDK 20.11.0.
All ABI changes must be detailed in the release notes. "My reword is wrong because ABI versions should be 20 and 21 respectively.
ACK - fixed
Quoted 9 lines
Quoted 7 lines
Quoted 5 lines
Quoted 2 lines
This is more ambiguous, although what I said above stands.
What you said is wrong because of 2 reasons:
- it is not always one year for an major ABIWell that is a point of disagreement.
The techboard agreed to remove "every year".
ACK - loosened the wording.
Quoted 9 lines
Quoted 5 lines
Quoted 2 lines
- it is always longer because of LTS branch
Well I was pretty careful to qualify the ABI policy applies to releases over the year. To distinguish it from LTS branch.
As above, we may replace "ABI is supported" with
"ABI compatibility is enforced".
Quoted 8 lines
Quoted 4 lines
Quoted 4 lines
Quoted 2 lines
If there is general agreement with changing this part of the policy, I am ok to make the change.
Yes let's review with the techboard.
Please try to reflect techboard comments while keeping something understandable :)
###
ACK - yes, it is readable.
Quoted 19 lines
Quoted 12 lines
Quoted 12 lines
Quoted 12 lines
Quoted 6 lines
Review
Quoted 3 lines
(quoted diff) +2
-0+ ABI breakages due to changes such as reorganizing public + structure fields for aesthetic or readability purposes should be avoided.Why it should be avoided?
If the ABI is broken anyway, I don't see any reason to not break it more.This is text from the original ABI Policy - I think the general sentiment still stands. Just because you have an ABI Breakage window doesn't mean you should feel free to break the ABI. The 3 ACKs required from Technical Board member to change the ABI, are another reflection of this.
Quoted 6 lines
Quoted 6 lines
Quoted 2 lines
As a general rule.
Unnecessary changes should still be avoided, to reduce ABI churn between ABI versions.I agree we must avoid unnecessary API changes because it requires apps to adapt. But if the change is only ABI, and we are in an ABI-change window, I don't see any issue
Quoted 8 lines
The techboard agrees that the ABI changes are unlimited but API changes must be avoided. It is suggested to replace "ABI" with "API". I think this reword is better:
"
API changes such as reorganizing public structure fields
for aesthetic or readability purposes should be avoided.
"###
ACK - done
Quoted 27 lines
Quoted 16 lines
Quoted 16 lines
Quoted 16 lines
Quoted 10 lines
doc/guides/contributing/abi_policy.rst In addition to tagging the code with ``__rte_experimental``, · line 320
Quoted 6 lines
doc/guides/contributing/abi_policy.rst +5
-0+Libraries marked as ``experimental`` are entirely not considered part of an ABI +version, and may change without warning at any time. Experimental libraries +always have a major version of ``0`` to indicate they exist outside of +ABI Versioning, with the minor version incremented with each ABI change +to library.It means not all libraries will have the same ABI version. It is contrary of "ABI version is managed at a project level", and I don't see a real benefit of a different version number.
There is a benefit, major version 0 is a very clear indication that the library exists outside of ABI management.
A library isn't in the ABI, until it is in the ABI - an then it gets added to the major version number.Quoted 7 lines
Quoted 7 lines
Quoted 5 lines
Quoted 2 lines
Anyway, some experimental functions can live inside a library with a stable ABI version number
True, but if an entire library is experimental - let's be crystal clear about that.
I would like to see what others think.
The techboard decided to keep this policy: .0 for pure experimental libs.
Quoted 15 lines
-----Original Message-----
From: Ray Kinsella <[email protected]>
Sent: Tuesday, November 5, 2019 3:24 PM
To: [email protected]
Cc: [email protected]; [email protected]; [email protected]; Richardson, Bruce <[email protected]>; Yigit, Ferruh <[email protected]>; Ananyev, Konstantin <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: [PATCH v8 2/4] doc: changes to abi policy introducing major abi versions
Quoted 7 lines
This policy change introduces major ABI versions, these are declared every year, typically aligned with the LTS release and are supported by subsequent releases in the following year. This change is intended to improve ABI stabilty for those projects consuming DPDK.
Signed-off-by Ray Kinsella <[email protected]>
PATCH v8 3/4 doc: updates to versioning guide for abi versions
In reply to Ray KinsellaUpdates to the ABI versioning guide, to account for the changes to the DPDK ABI/API policy. Fixes for references to abi versioning and policy guides.
--- doc/guides/contributing/abi_policy.rst | 15 +- doc/guides/contributing/abi_versioning.rst | 250 +++++++++++++++++++---------- doc/guides/contributing/patches.rst | 6 +- doc/guides/rel_notes/deprecation.rst | 6 +- 4 files changed, 183 insertions(+), 94 deletions(-)
doc/guides/contributing/abi_policy.rst +8 -7
@@ -16,11 +16,11 @@ General Guidelines #. Major ABI versions are declared every **year** and are then supported for one year, typically aligned with the :ref:`LTS release <stable_lts_releases>`. #. The ABI version is managed at a project level in DPDK, with the ABI version - reflected in all library's soname. + reflected in all :ref:`library's soname <what_is_soname>`. #. The ABI should be preserved and not changed lightly. ABI changes must follow the outlined :ref:`deprecation process <abi_changes>`. #. The addition of symbols is generally not problematic. The modification of - symbols is managed with ABI Versioning. + symbols is managed with :ref:`ABI Versioning <abi_versioning>`. #. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`, once approved these will form part of the next ABI version. #. Libraries or APIs marked as :ref:`Experimental <experimental_apis>` are not
@@ -64,13 +64,14 @@ An ABI version is an instance of a library's ABI at a specific release. Certain releases are considered to be milestone releases, the yearly LTS release for example. The ABI of a milestone release may be designated as a 'major ABI version', where this ABI version is then supported for some number of subsequent -releases and is annotated in the library's soname. +releases and is annotated in the library's :ref:`soname<what_is_soname>`. ABI version support in subsequent releases facilitates application upgrades, by enabling applications built against the milestone release to upgrade to subsequent releases of a library without a rebuild. -More details on major ABI version can be found in the ABI Versioning guide. +More details on major ABI version can be found in the :ref:`ABI versioning +<major_abi_versions>` guide. The DPDK ABI policy -------------------
@@ -141,7 +142,7 @@ The requirements for changing the ABI are: CPU vendors, end-users, etc. #. Backward compatibility with the major ABI version must be maintained through - ABI Versioning, with :ref:`forward-only <forward-only>` compatibility + :ref:`abi_versioning`, with :ref:`forward-only <forward-only>` compatibility offered for any ABI changes that are indicated to be part of the next ABI version.
@@ -218,7 +219,7 @@ declarations of major ABI versions. * DPDK 20.02 release defines a new function ``rte_foo(uint8_t bar)``, and this is not a problem as long as the symbol ``rte_foo@DPDK20`` is - preserved through ABI Versioning. + preserved through :ref:`abi_versioning`. - The new function may be marked with the ``__rte_experimental`` tag for a number of releases, as described in the section :ref:`experimental_apis`.
@@ -316,5 +317,5 @@ Libraries Libraries marked as ``experimental`` are entirely not considered part of an ABI version, and may change without warning at any time. Experimental libraries always have a major version of ``0`` to indicate they exist outside of -ABI Versioning, with the minor version incremented with each ABI change +:ref:`abi_versioning` , with the minor version incremented with each ABI change to library.
doc/guides/contributing/abi_versioning.rst +169 -81
388 lines not on this page · raw message
doc/guides/contributing/patches.rst +3 -3
@@ -156,9 +156,9 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * For other PMDs and more info, refer to the ``MAINTAINERS`` file. -* New external functions should be added to the local ``version.map`` file. - See the :doc:`Guidelines for ABI policy and versioning </contributing/abi_versioning>`. - New external functions should also be added in alphabetical order. +* New external functions should be added to the local ``version.map`` file. See + the :doc:`ABI policy <abi_policy>` and :ref:`ABI versioning <abi_versioning>` + guides. New external functions should also be added in alphabetical order. * Important changes will require an addition to the release notes in ``doc/guides/rel_notes/``. See the :ref:`Release Notes section of the Documentation Guidelines <doc_guidelines>` for details.
doc/guides/rel_notes/deprecation.rst +3 -3
@@ -4,9 +4,9 @@ ABI and API Deprecation ======================= -See the :doc:`guidelines document for details of the ABI policy </contributing/abi_versioning>`. -API and ABI deprecation notices are to be posted here. - +See the guidelines document for details of the :doc:`ABI policy +<../contributing/abi_policy>`. API and ABI deprecation notices are to be posted +here. Deprecation Notices -------------------
Signature · 1 line
2.7.4
Re: [dpdk-dev] [PATCH v8 3/4] doc: updates to versioning guide for abi versions
Quoted 5 lines · On Tue, 5 Nov 2019 15:24:17 +0000 Ray Kinsella <[email protected]> wrote:
Updates to the ABI versioning guide, to account for the changes to the DPDK ABI/API policy. Fixes for references to abi versioning and policy guides.
Signed-off-by Ray Kinsella <[email protected]>---
Re: [dpdk-dev] [PATCH v8 3/4] doc: updates to versioning guide for abi versions
In reply to Ray KinsellaQuoted 16 lines
-----Original Message-----
From: Ray Kinsella <[email protected]>
Sent: Tuesday, November 5, 2019 3:24 PM
To: [email protected]
Cc: [email protected]; [email protected]; [email protected]; Richardson, Bruce <[email protected]>; Yigit, Ferruh <[email protected]>; Ananyev, Konstantin <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: [PATCH v8 3/4] doc: updates to versioning guide for abi versions
Quoted 5 lines
Updates to the ABI versioning guide, to account for the changes to the DPDK ABI/API policy. Fixes for references to abi versioning and policy guides.
Signed-off-by Ray Kinsella <[email protected]>
PATCH v8 4/4 doc: add maintainer for abi policy
In reply to Ray KinsellaAdd an entry to the maintainer file for the abi policy.
--- MAINTAINERS | 4 ++++ 1 file changed, 4 insertions(+)
MAINTAINERS +4 -0
@@ -84,6 +84,10 @@ M: Marko Kovacevic <[email protected]> F: README F: doc/ +ABI Policy +M: Ray Kinsella <[email protected]> +F: doc/guides/contributing/abi_*.rst + Developers and Maintainers Tools M: Thomas Monjalon <[email protected]> F: MAINTAINERS
Signature · 1 line
2.7.4
Re: [dpdk-dev] [PATCH v8 4/4] doc: add maintainer for abi policy
Quoted 16 lines
-----Original Message-----
From: Ray Kinsella <[email protected]>
Sent: Tuesday, November 5, 2019 3:24 PM
To: [email protected]
Cc: [email protected]; [email protected]; [email protected]; Richardson, Bruce <[email protected]>; Yigit, Ferruh <[email protected]>; Ananyev, Konstantin <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: [PATCH v8 4/4] doc: add maintainer for abi policy
Quoted 2 lines
Add an entry to the maintainer file for the abi policy.