merge master

Author: kkloberdanz

.mci.yml

@@ -283,7 +283,8 @@ functions:
             add_expansions_to_env: true
             script: mongo-cxx-driver/.evergreen/install_c_driver.sh
 
-    # This function may be used to fetch CI scripts in the C driver
+    # fetch_c_driver_source may be used to fetch the C driver source without installing the C driver.
+    # This can be used when only CI scripts are needed.
     "fetch_c_driver_source":
       - command: shell.exec
         params:
@@ -857,6 +858,7 @@ tasks:
               RUN_DISTCHECK: 1
         - func: "clone_drivers-evergreen-tools"
         - func: "run_kms_servers"
+        # Call "install_c_driver" before "test" to build static C driver libraries. Example projects require static C driver libraries.
         - func: "install_c_driver"
         - func: "test"
 

CMakeLists.txt

@@ -198,9 +198,12 @@ To build static libraries only, set both BUILD_SHARED_LIBS and BUILD_SHARED_AND_
 endif()
 
 
-# If the user did not customize the install prefix,
-# set it to live under build so we don't inadvertently pollute /usr/local
-if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+option(USE_DEFAULT_INSTALL_PATH "Override the CMake default installation path" OFF)
+if(NOT CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND USE_DEFAULT_INSTALL_PATH)
+    message(FATAL_ERROR "You cannot set both CMAKE_INSTALL_PREFIX and USE_DEFAULT_INSTALL_PATH")
+endif()
+if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND NOT USE_DEFAULT_INSTALL_PATH)
+    message(WARNING "the CMake default install path is being overridden to the build directory. This behavior will not be the default in a future release. Build with -DUSE_DEFAULT_INSTALL_PATH=ON to opt into what will be the default behavior in a future release. Setting install path to: ${CMAKE_BINARY_DIR}/install")
     set (CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/install" CACHE PATH "default install path" FORCE)
 endif()
 

docs/content/mongocxx-v3/installation/linux.md

@@ -71,7 +71,7 @@ from source. To configure `mongocxx` for installation into `/usr/local` as well,
 ```
 cmake ..                                \
     -DCMAKE_BUILD_TYPE=Release          \
-    -DCMAKE_INSTALL_PREFIX=/usr/local
+    -DUSE_DEFAULT_INSTALL_PATH=ON
 ```
 
 These options can be freely mixed with a C++17 polyfill option. For instance, this is how a user
@@ -80,7 +80,7 @@ would run the command above with the Boost polyfill option:
 cmake ..                                            \
     -DCMAKE_BUILD_TYPE=Release                      \
     -DBSONCXX_POLY_USE_BOOST=1                      \
-    -DCMAKE_INSTALL_PREFIX=/usr/local
+    -DUSE_DEFAULT_INSTALL_PATH=ON
 ```
 
 ### Step 4: Build and install the driver

docs/content/mongocxx-v3/installation/macos.md

@@ -71,7 +71,7 @@ from source. To configure `mongocxx` for installation into `/usr/local` as well,
 ```
 cmake ..                                \
     -DCMAKE_BUILD_TYPE=Release          \
-    -DCMAKE_INSTALL_PREFIX=/usr/local
+    -DUSE_DEFAULT_INSTALL_PATH=ON
 ```
 
 These options can be freely mixed with a C++17 polyfill option. For instance, this is how a user
@@ -80,7 +80,7 @@ would run the command above with the Boost polyfill option:
 cmake ..                                            \
     -DCMAKE_BUILD_TYPE=Release                      \
     -DBSONCXX_POLY_USE_BOOST=1                      \
-    -DCMAKE_INSTALL_PREFIX=/usr/local
+    -DUSE_DEFAULT_INSTALL_PATH=ON
 ```
 
 ### Step 4: Build and install the driver

src/bsoncxx/enums/binary_sub_type.hpp

@@ -24,4 +24,5 @@ BSONCXX_ENUM(uuid, 0x04)
 BSONCXX_ENUM(md5, 0x05)
 BSONCXX_ENUM(encrypted, 0x06)
 BSONCXX_ENUM(column, 0x07)
+BSONCXX_ENUM(sensitive, 0x08)
 BSONCXX_ENUM(user, 0x80)

src/bsoncxx/types.hpp

@@ -570,10 +570,6 @@ BSONCXX_INLINE bool operator==(const b_int32& lhs, const b_int32& rhs) {
 ///
 /// A BSON replication timestamp value.
 ///
-/// @warning
-///   This BSON type is used internally by the MongoDB server - use by clients
-///   is discouraged.
-///
 struct BSONCXX_API b_timestamp {
     static constexpr auto type_id = type::k_timestamp;