numam-dpdk/doc/guides/contributing
Ferruh Yigit 05a38d7c75 compat: provide experimental alias for matured ABI
On v20.02 some APIs matured and symbols moved from EXPERIMENTAL to
DPDK_20.0.1 block.

This had the affect of breaking the applications that were using these
APIs on v19.11. Although there is no modification of the APIs and the
action is positive and matures the APIs, the affect can be negative to
applications.

When a maintainer is promoting an API to become part of the next major
ABI version by removing the experimental tag. The maintainer may
choose to offer an alias to the experimental tag, to prevent these
breakages in future.

The following changes are made to enabling aliasing:

Updated to the ABI policy and ABI versioning documents.

Created VERSION_SYMBOL_EXPERIMENTAL helper macro.

Updated the 'check-symbols.sh' tool, which was complaining that the
symbol is in EXPERIMENTAL tag in .map file but it is not in the
.experimental section (__rte_experimental tag is missing).
Updated tool in a way it won't complain if the symbol in the
EXPERIMENTAL tag duplicated in some other block in .map file (versioned)

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
Acked-by: Neil Horman <nhorman@tuxdriver.com>
2020-05-18 19:46:25 +02:00
..
img doc: introduce major ABI versions 2019-11-12 09:03:46 +01:00
abi_policy.rst compat: provide experimental alias for matured ABI 2020-05-18 19:46:25 +02:00
abi_versioning.rst compat: provide experimental alias for matured ABI 2020-05-18 19:46:25 +02:00
cheatsheet.rst doc: add SPDX and copyright to contributing guide 2018-08-09 22:48:10 +02:00
coding_style.rst build: disable experimental API check internally 2020-04-14 16:22:34 +02:00
design.rst mk: use linux and freebsd in config names 2019-03-12 23:05:06 +01:00
documentation.rst doc: remove major in designation of normal releases 2020-02-14 08:54:26 +01:00
index.rst doc: separate versioning guide into version and policy 2019-11-12 09:03:15 +01:00
patches.rst devtools: add ABI checks 2020-02-05 15:14:46 +01:00
stable.rst doc: remove major in designation of normal releases 2020-02-14 08:54:26 +01:00
vulnerability.rst doc: add oss-security to the security process 2019-11-15 09:54:55 +01:00