From: Ray Kinsella Date: Tue, 7 Jul 2020 17:51:01 +0000 (+0100) Subject: doc: clarify period of alias to experimental symbol X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=06df45af6e47df46c7f1c7e5b5c218071151f5d3;p=dpdk.git doc: clarify period of alias to experimental symbol Clarify retention period for aliases to experimental. Signed-off-by: Ray Kinsella Reviewed-by: Honnappa Nagarahalli --- diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst index 31a9205572..b1d09c7940 100644 --- a/doc/guides/contributing/abi_versioning.rst +++ b/doc/guides/contributing/abi_versioning.rst @@ -158,7 +158,7 @@ The macros exported are: * ``VERSION_SYMBOL_EXPERIMENTAL(b, e)``: Creates a symbol version table entry 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 - provide an alias to experimental for some time. + provide an alias to experimental until the next major ABI version. .. _example_abi_macro_usage: @@ -428,8 +428,9 @@ _____________________________ 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 -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. +This alias is then dropped in the next major ABI version. The process to provide an alias to ``experimental`` is similar to that, of :ref:`symbol versioning ` described above.