aboutsummaryrefslogtreecommitdiffstats
path: root/doc/abi.rst
blob: faf7bcc44a7d30682edb2f63699d0a23ececd87c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

ABI Stability
====================

Botan uses semantic versioning for the API; if API features are added the minor
version increases, whereas if API compatibility breaks occur the major version
is increased.

However no guarantees about ABI are made between releases. Maintaining an ABI
compatible release in a complex C++ API is exceedingly expensive in development
time; just adding a single member variable or virtual function is enough to
cause ABI issues.

If ABI changes, the soname revision will increase to prevent applications from
linking against a potentially incompatible version at runtime.

If you are concerned about long-term ABI issues, considering using the C API
instead; this subset *is* ABI stable.

You can review a report on ABI changes to Botan at
https://abi-laboratory.pro/tracker/timeline/botan/