summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2018-03-18 15:46:36 +0100
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2018-03-22 08:27:12 +0100
commitdb2d78023aaf2814b28afd6ce488d98b1100aec5 (patch)
treedae1de531706ac5e66cb8ef88569dc1d5b247dd0 /CONTRIBUTING.md
parent07a900e4d7c4def883de044c37fd1c44dee41417 (diff)
downloadgnutls-db2d78023aaf2814b28afd6ce488d98b1100aec5.tar.gz
The abi-check target was updated to check against the last tag
As abi-dumper and abi-compliance-checker tools are not reliable when run across different systems, we now compare the previous tag ABI with the current compiled library. That is in contrast with the previous behavior of storing the output files of abi-dumper, which can become obsolete on a CI update. That also moves the ABI check only on the CI, and not in the 'make dist' rule as it takes significant time to run. This relates to an issue reported against libidn2's use of abi-compliance-checker but it affects gnutls as they share similar code: https://gitlab.com/libidn/libidn2/issues/42 Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3ddae0821e..cc63fe07d0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -113,6 +113,10 @@ As such, some questions to answer before adding a new API:
13.0 is made available? Would it harm the addition of a new protocol?
+The make rule 'abi-check' verifies that the ABI remained compatible since
+the last tagged release. It relies on the git tree and abi-compliance-checker.
+
+
# Constructed types:
The constructed types in gnutls always have the ```gnutls_``` prefix.