extras/abi/README.md

   1 <!--
   2 SPDX-FileCopyrightText: 2023 EfficiOS Inc.
   3
   4 SPDX-License-Identifier: CC-BY-4.0
   5 -->
   6
   7 # Userspace-RCU ABI definitions
   8
   9 This directory contains the serialized ABI definitions for a typical build of
  10 the liburcu libraries. This information is extracted using
  11 [libabigail](https://sourceware.org/libabigail/).
  12
  13 The artefacts used to generate these were built with **CFLAGS="-O0 -ggdb"** on
  14 an Ubuntu 18.04 x86_64 system.
  15
  16 You can compare the serialized ABI with a shared object to check for breaking
  17 changes. For example, here we compare an in-tree built version of
  18 **liburcu-memb.so** with the serialized ABI of stable-0.13 :
  19
  20 ````
  21 abidiff \
  22   extras/abi/0.13/x86_64-pc-linux-gnu/liburcu-memb.so.8.xml \
  23   src/.libs/liburcu-memb.so
  24 ````