Skip to content

Commit

Permalink
feedback, structure
Browse files Browse the repository at this point in the history
  • Loading branch information
norareidy committed Nov 21, 2024
1 parent fbcc2a1 commit 0032eb5
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 35 deletions.
2 changes: 1 addition & 1 deletion source/get-started/download-and-install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Download and Install

cmake .. \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_CXX_STANDARD=17 \
-DCMAKE_CXX_STANDARD=17

This command instructs CMake to install ``mongocxx`` into the ``/usr/local`` directory.

Expand Down
46 changes: 12 additions & 34 deletions source/upgrade.txt
Original file line number Diff line number Diff line change
Expand Up @@ -132,44 +132,22 @@ Build System Breaking Changes in v4.0
`````````````````````````````````````

The v4.0 driver introduces the following breaking changes to the build system:

.. warning:: Build System Breaking Changes

The v4.0 driver introduces the following breaking changes to the build system:

- Drops support for the Boost and MNMLSTC/core external polyfill libraries. You can no
longer set the following configuration options:

- ``ENABLE_BSONCXX_POLY_USE_IMPLS``. This option is implicitly set to ``ON``.
- ``BSONCXX_POLY_USE_MNMLSTC``.
- ``BSONCXX_POLY_USE_SYSTEM_MNMLSTC``.
- ``BSONCXX_POLY_USE_BOOST``.

- Drops support for the ``MONGOCXX_OVERRIDE_DEFAULT_INSTALL_PREFIX`` configuration
option. This option is implicitly set to ``OFF``.

- Sets the ``ENABLE_TESTS`` configuration option to ``OFF`` by default. To
re-enable building test targets, you must set ``ENABLE_TESTS`` to ``ON``.
To include test targets in the "all" target, you must also set the
``BUILD_TESTING`` option to ``ON``.

.. warning:: API Breaking Changes

The v4.0 driver introduces the following breaking changes to the API:

- Drops support for configuring ``bsoncxx::stdx::string_view`` and
``bsoncxx::stdx::optional<T>`` as aliases for Boost or MNMLSTC/core
library equivalents. For context, see the :ref:`Build System Breaking Changes
<version-4.0-build-system-breaking>` admonition.
- Drops support for the Boost and MNMLSTC/core external polyfill libraries. You can no
longer set the following configuration options:

.. warning:: ABI Breaking Changes
- ``ENABLE_BSONCXX_POLY_USE_IMPLS``. This option is implicitly set to ``ON``.
- ``BSONCXX_POLY_USE_MNMLSTC``.
- ``BSONCXX_POLY_USE_SYSTEM_MNMLSTC``.
- ``BSONCXX_POLY_USE_BOOST``.

The v4.0 driver introduces the following breaking changes to the ABI:
- Drops support for the ``MONGOCXX_OVERRIDE_DEFAULT_INSTALL_PREFIX`` configuration
option. This option is implicitly set to ``OFF``.

- Drops support for configuring ``bsoncxx::stdx::string_view`` and
``bsoncxx::stdx::optional<T>`` as aliases for Boost or MNMLSTC/core
library equivalents. For context, see the :ref:`Build System Breaking Changes
<version-4.0-build-system-breaking>` admonition.
- Sets the ``ENABLE_TESTS`` configuration option to ``OFF`` by default. To
re-enable building test targets, you must set ``ENABLE_TESTS`` to ``ON``.
To include test targets in the "all" target, you must also set the
``BUILD_TESTING`` option to ``ON``.

API Breaking Changes in v4.0
````````````````````````````
Expand Down

0 comments on commit 0032eb5

Please sign in to comment.