Add serialized ABI definition files

[lttng-ust.git] / extras / abi / README

diff --git a/extras/abi/README b/extras/abi/README
new file mode 100644 (file)
index 0000000..c21624e
--- /dev/null
+++ b/extras/abi/README
@@ -0,0 +1,14 @@
+This directory contains the serialized ABI definitions for a typical build of
+the lttng-ust librairies. This information is extracted using libabigail
+(https://sourceware.org/libabigail/).
+
+The artefacts used to generate these were built with CFLAGS="-O0 -ggdb" and all
+optional configure switches enabled.
+
+You can compare the serialized ABI with a shared object to check for breaking
+changes. For example, here we compare an in-tree built version of
+liblttng-ust.so with the serialized ABI of stable-2.13 :
+
+  abidiff \
+    extras/abi/2.13/x86_64-pc-linux-gnu/liblttng-ust.so.1.xml \
+    src/lib/lttng-ust/.libs/liblttng-ust.so