devtools: document ABI check suppression rules

Suppression rules are being added during the life of an ABI and cleaned
when bumping the major version.
Sort and document those rules to avoid pruning rules that should be kept.

Signed-off-by: David Marchand <david.marchand@redhat.com>
This commit is contained in:
David Marchand 2022-03-23 10:24:00 +01:00 committed by Thomas Monjalon
parent 1d5e58e9b6
commit 381813e63d

View File

@ -1,3 +1,7 @@
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Core suppression rules: DO NOT TOUCH ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
[suppress_function]
symbol_version = EXPERIMENTAL
[suppress_variable]
@ -16,15 +20,23 @@
[suppress_file]
soname_regexp = ^librte_.*mlx.*glue\.
; Ignore fields inserted in place of reserved_opts of rte_security_ipsec_sa_options
[suppress_type]
name = rte_security_ipsec_sa_options
has_data_member_inserted_between = {offset_of(reserved_opts), end}
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Experimental APIs exceptions ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Ignore changes to rte_crypto_asym_op, asymmetric crypto API is experimental
[suppress_type]
name = rte_crypto_asym_op
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Temporary exceptions till next major ABI version ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Ignore fields inserted in place of reserved_opts of rte_security_ipsec_sa_options
[suppress_type]
name = rte_security_ipsec_sa_options
has_data_member_inserted_between = {offset_of(reserved_opts), end}
; Ignore section attribute fixes in experimental regexdev library
[suppress_file]
soname_regexp = ^librte_regexdev\.