From 28b924fe3036b081b22b3a56454de71a47b3de53 Mon Sep 17 00:00:00 2001 From: Martchus Date: Wed, 25 Nov 2020 17:53:14 +0100 Subject: [PATCH] Document API/ABI stability --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 4d09443..a1123dd 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,18 @@ Besides, the library provides a few useful algorithms and data structures: * Damerau–Levenshtein distance * *N*-dimensional array +## API/ABI stability +The following counts for `c++utilities` and my other libraries unless stated otherwise: + +* Different major versions are incompatible (API- and ABI-wise). Different major versions can be + installed within the same prefix using the CMake variable `CONFIGURATION_NAME` (see documentation + about build variables mentioned below). +* Minor versions are backwards compatible (API- and ABI-wise) to previous ones within the same major + version. +* Patch versions are interchangeable (API- and ABI-wise) within the same major/minor version. +* Some functions or classes are experimental. They might be modified in an incompatible way or even + removed in the next minor or patch release. + ## Build instructions ### Requirements #### Build-only dependencies