X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=extras%2Fabi%2FREADME.md;fp=extras%2Fabi%2FREADME.md;h=a7242a22c788c3607e8b39b13e70ff8bd28aacfb;hb=d001c88633f6a58e94eb73f4814976d13f61bd77;hp=0000000000000000000000000000000000000000;hpb=65eaf4b646f566324b92c25c8760a204bfbdffa8;p=urcu.git

diff --git a/extras/abi/README.md b/extras/abi/README.md
new file mode 100644
index 0000000..a7242a2
--- /dev/null
+++ b/extras/abi/README.md
@@ -0,0 +1,24 @@
+<!--
+SPDX-FileCopyrightText: 2023 EfficiOS Inc.
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+# Userspace-RCU ABI definitions
+
+This directory contains the serialized ABI definitions for a typical build of
+the liburcu libraries. This information is extracted using
+[libabigail](https://sourceware.org/libabigail/).
+
+The artefacts used to generate these were built with **CFLAGS="-O0 -ggdb"** on
+an Ubuntu 18.04 x86_64 system.
+
+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
+**liburcu-memb.so** with the serialized ABI of stable-0.13 :
+
+````
+abidiff \
+  extras/abi/0.13/x86_64-pc-linux-gnu/liburcu-memb.so.8.xml \
+  src/.libs/liburcu-memb.so
+````