diff --git a/source/api-abi-versioning.txt b/source/api-abi-versioning.txt index 328310bf..987aedad 100644 --- a/source/api-abi-versioning.txt +++ b/source/api-abi-versioning.txt @@ -54,12 +54,12 @@ The public header files of the bsoncxx library are organized by ABI namespace: For forward compatibility, a public header file in an ABI namespace directory ``vA`` may include a header file in a *newer* ABI namespace directory ``vB``, where ``A < B``. Such forward compatibility include directives, when supported, will be explicitly documented. -For any given public API entity, we recommend including its corresponding header -from the *latest* ABI namespace directory whenever available. +When ABI stability is required, we recommend including headers from the *latest* stable ABI namespace directory. +If ABI stability is not required, we recommend including the appropriate *unstable* ABI header instead. .. important:: - For backward compatibility, the ``bsoncxx/v_noabi/`` ABI namespace directory is added to include paths such that ``#include `` is equivalent to ``#include ``. Relying on this behavior is discouraged: we recommend explicitly including ``#include `` instead. + The ``bsoncxx/v_noabi/`` unstable ABI namespace directory is prioritized before the ``bsoncxx/`` root directory in include paths, such that ``#include `` is equivalent to ``#include ``. .. note::