+++ date = "2016-08-15T16:11:58+05:30" title = "API and ABI versioning" [menu.main] weight = 20 parent="mongocxx3" +++
- We use semantic versioning.
- bsoncxx and mongocxx both define corresponding CMake variables for MAJOR, MINOR, and PATCH.
- Both bsoncxx and mongocxx both have a single scalar ABI version.
- Only bump ABI version on incompatible ABI change (not for ABI additions).
- We stay on ABI version _noabi (without bumping for incompatible changes) until ABI is stable.
Parallel Header Installation
- For mongocxx, install all headers to
- For bsoncxx, install all headers to
- We install a pkg-config file to shield consumers from this complexity.
Sonames and symlinks
Note that below examples are given for libmongocxx, but also apply to libbsoncxx
DSO = Dynamic Shared Object, to use Ulrich Drepper's terminology
- Physical filename for a DSO is
Note that the physical filename is disconnected from ABI version/soname. This looks a bit strange, but allows multiple versions of the library with the same ABI version to be installed on the same system.
- soname for a DSO is
We provide a soname symlink that links to the physical DSO. We also provide a dev symlink that links to the soname symlink of the highest ABI version of the library installed.
- We provide inline namespace macros for both mongocxx and bsoncxx.
- This allows multiple, ABI incompatible versions of the library to be linked into the same application.
- The name of the namespace is
v$ABI. We create them from ABI version to maintain forwards compatibibility.