Skip to content

Commit 21d406c

Browse files
eramongodbnorareidy
authored andcommitted
Remove recommendation against including unqualified unstable ABI headers (#59)
(cherry picked from commit c426e8b)
1 parent 26a19cf commit 21d406c

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

source/api-abi-versioning.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ The public header files of the bsoncxx library are organized by ABI namespace:
5454

5555
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``.
5656
Such forward compatibility include directives, when supported, will be explicitly documented.
57-
For any given public API entity, we recommend including its corresponding header
58-
from the *latest* ABI namespace directory whenever available.
57+
When ABI stability is required, we recommend including headers from the *latest* stable ABI namespace directory.
58+
If ABI stability is not required, we recommend including the appropriate *unstable* ABI header instead.
5959

6060
.. important::
6161

62-
For backward compatibility, the ``bsoncxx/v_noabi/`` ABI namespace directory is added to include paths such that ``#include <bsoncxx/example.hpp>`` is equivalent to ``#include <bsoncxx/v_noabi/bsoncxx/example.hpp>``. Relying on this behavior is discouraged: we recommend explicitly including ``#include <bsoncxx/v_noabi/bsoncxx/example.hpp>`` instead.
62+
The ``bsoncxx/v_noabi/`` unstable ABI namespace directory is prioritized before the ``bsoncxx/`` root directory in include paths, such that ``#include <bsoncxx/example.hpp>`` is equivalent to ``#include <bsoncxx/v_noabi/bsoncxx/example.hpp>``.
6363

6464
.. note::
6565

0 commit comments

Comments
 (0)