From 0032eb535d99c8d29d6b639ce711f973718af27e Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 21 Nov 2024 17:16:54 -0500 Subject: [PATCH] feedback, structure --- source/get-started/download-and-install.txt | 2 +- source/upgrade.txt | 46 ++++++--------------- 2 files changed, 13 insertions(+), 35 deletions(-) diff --git a/source/get-started/download-and-install.txt b/source/get-started/download-and-install.txt index c658042e..70e657c4 100644 --- a/source/get-started/download-and-install.txt +++ b/source/get-started/download-and-install.txt @@ -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. diff --git a/source/upgrade.txt b/source/upgrade.txt index 6c161c58..93bd1af0 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -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`` as aliases for Boost or MNMLSTC/core - library equivalents. For context, see the :ref:`Build System Breaking Changes - ` 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`` as aliases for Boost or MNMLSTC/core - library equivalents. For context, see the :ref:`Build System Breaking Changes - ` 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 ````````````````````````````