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

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
Commit	Line	Data
7538241b	1	This directory contains the serialized ABI definitions for a typical build of
2fbda51c	2	the lttng-ust libraries. This information is extracted using libabigail
7538241b MJ	3	(https://sourceware.org/libabigail/).
	4
	5	The artefacts used to generate these were built with CFLAGS="-O0 -ggdb" and all
	6	optional configure switches enabled.
	7
	8	You can compare the serialized ABI with a shared object to check for breaking
	9	changes. For example, here we compare an in-tree built version of
	10	liblttng-ust.so with the serialized ABI of stable-2.13 :
	11
	12	abidiff \
	13	extras/abi/2.13/x86_64-pc-linux-gnu/liblttng-ust.so.1.xml \
	14	src/lib/lttng-ust/.libs/liblttng-ust.so