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

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