d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: clarify period of alias to experimental symbol

Browse Source 
Clarify retention period for aliases to experimental.

Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
This commit is contained in:
Ray Kinsella 2020-07-07 18:51:01 +01:00 committed by Thomas Monjalon
parent 2bfd75a698
commit 06df45af6e
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/guides/contributing/abi_versioning.rst
View File

@ -158,7 +158,7 @@ The macros exported are:
* ``VERSION_SYMBOL_EXPERIMENTAL(b, e)``: Creates a symbol version table entry * ``VERSION_SYMBOL_EXPERIMENTAL(b, e)``: Creates a symbol version table entry
binding versioned symbol ``b@EXPERIMENTAL`` to the internal function ``be``. binding versioned symbol ``b@EXPERIMENTAL`` to the internal function ``be``.
The macro is used when a symbol matures to become part of the stable ABI, to The macro is used when a symbol matures to become part of the stable ABI, to
provide an alias to experimental for some time. provide an alias to experimental until the next major ABI version.
.. _example_abi_macro_usage: .. _example_abi_macro_usage:
@ -428,8 +428,9 @@ _____________________________
In situations in which an ``experimental`` symbol has been stable for some time, In situations in which an ``experimental`` symbol has been stable for some time,
and it becomes a candidate for promotion to the stable ABI. At this time, when and it becomes a candidate for promotion to the stable ABI. At this time, when
promoting the symbol, maintainer may choose to provide an alias to the promoting the symbol, the maintainer may choose to provide an alias to the
``experimental`` symbol version, so as not to break consuming applications. ``experimental`` symbol version, so as not to break consuming applications.
This alias is then dropped in the next major ABI version.
The process to provide an alias to ``experimental`` is similar to that, of The process to provide an alias to ``experimental`` is similar to that, of
:ref:`symbol versioning <example_abi_macro_usage>` described above. :ref:`symbol versioning <example_abi_macro_usage>` described above.