X-Git-Url: https://git.lttng.org/?p=lttng-ust.git;a=blobdiff_plain;f=extras%2Fabi%2FREADME.md;fp=extras%2Fabi%2FREADME.md;h=1e5406932dcaf7597e17ba5a0c542c25f6f7f597;hp=0000000000000000000000000000000000000000;hb=e03d7c66c57bf268b87296566a5160039f35ccfb;hpb=79f8dc6f50b20fb6b1d99f9bd97d70aa361bc6ad

diff --git a/extras/abi/README.md b/extras/abi/README.md
new file mode 100644
index 00000000..1e540693
--- /dev/null
+++ b/extras/abi/README.md
@@ -0,0 +1,22 @@
+<!--
+SPDX-FileCopyrightText: 2023 EfficiOS, Inc.
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+This directory contains the serialized ABI definitions for a typical build of
+the lttng-ust libraries. 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
+```