X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=extras%2Fabi%2FREADME;fp=extras%2Fabi%2FREADME;h=c21624ecb1564aa671f235d9b148aec11a68ce23;hb=7538241befdda770998d3354968214729a9fc4e4;hp=0000000000000000000000000000000000000000;hpb=5b1163c6cf674c6461cc1e0ad1211924df7af789;p=lttng-ust.git

diff --git a/extras/abi/README b/extras/abi/README
new file mode 100644
index 00000000..c21624ec
--- /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