diff --git a/config/redirects b/config/redirects index d9229f0f..12c290b5 100644 --- a/config/redirects +++ b/config/redirects @@ -1,8 +1,8 @@ define: prefix docs/languages/cpp/cpp-driver define: base https://www.mongodb.com/${prefix} -define: versions v3.10 3.11 master +define: versions v3.10 v3.11 v4.0 master -symlink: current -> v3.11 +symlink: current -> v4.0 symlink: upcoming -> master raw: ${prefix}/ -> ${base}/current/ diff --git a/snooty.toml b/snooty.toml index 55426e98..b60ed13d 100644 --- a/snooty.toml +++ b/snooty.toml @@ -24,7 +24,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" driver = "cpp" driver-long = "MongoDB C++ Driver" driver-short = "C++ driver" -version = "3.11" +version = "4.0" full-version = "{+version+}.0" api = "https://mongocxx.org/api/current" string-data-type = "``string``" diff --git a/source/advanced-installation.txt b/source/advanced-installation.txt index b4969bdd..e25ee6af 100644 --- a/source/advanced-installation.txt +++ b/source/advanced-installation.txt @@ -170,22 +170,11 @@ Install the MongoDB C Driver The mongocxx driver builds on top of the `MongoDB C driver `__. -The build of mongocxx-3.9.0 automatically downloads and installs the C driver if the C driver is not detected. -To use an existing install of the C driver, set ``CMAKE_PREFIX_PATH`` to the directory containing the C driver install. - -- For mongocxx-3.11.x, libmongoc 1.28.0 or later is required. -- For mongocxx-3.10.x, libmongoc 1.25.0 or later is required. -- For mongocxx-3.9.x, libmongoc 1.25.0 or later is required. -- For mongocxx-3.8.x, libmongoc 1.24.0 or later is required. -- For mongocxx-3.7.x, libmongoc 1.22.1 or later is required. -- For mongocxx-3.6.x, libmongoc 1.17.0 or later is required. -- For mongocxx-3.5.x, libmongoc 1.15.0 or later is required. -- For mongocxx-3.4.x, libmongoc 1.13.0 or later is required. -- For mongocxx-3.3.x, libmongoc 1.10.1 or later is required. -- For mongocxx-3.2.x, libmongoc 1.9.2 or later is required. -- For mongocxx-3.1.4+, libmongoc 1.7.0 or later is required. -- For mongocxx-3.1.[0-3], libmongoc 1.5.0 or later is required. -- For mongocxx-3.0.x, we recommend the last 1.4.x version of libmongoc +The build of mongocxx-3.9.0 automatically downloads and installs the C driver if the +C driver is not detected. To use an existing install of the C driver, set +``CMAKE_PREFIX_PATH`` to the directory containing the C driver install. For information +about the minimum required ``libmongoc`` version for each version of the C++ driver, see +:ref:`cpp-libmongoc-compatibility`. Unless you know that your package manager offers a sufficiently recent version, you will need to download and build from the source code. Get a tarball from diff --git a/source/compatibility.txt b/source/compatibility.txt index 317aa962..1e5bf3b0 100644 --- a/source/compatibility.txt +++ b/source/compatibility.txt @@ -41,5 +41,16 @@ The first column lists the driver version. .. include:: /includes/language-compatibility-table-cxx.rst +.. _cpp-libmongoc-compatibility: + +libmongoc Compatibility +----------------------- + +The following compatibility table specifies the required version of libmongoc. + +The first column lists the driver version. + +.. include:: /includes/libmongoc-compatibility-table-cxx.rst + For more information on how to read the compatibility tables, see our guide on :ref:`MongoDB Compatibility Tables. ` \ No newline at end of file diff --git a/source/includes/language-compatibility-table-cxx.rst b/source/includes/language-compatibility-table-cxx.rst index 79d1065c..c1dc30f6 100644 --- a/source/includes/language-compatibility-table-cxx.rst +++ b/source/includes/language-compatibility-table-cxx.rst @@ -9,7 +9,7 @@ - C++14 - C++11 - * - 3.8 to 3.11 + * - 3.8 to 4.0 - ✓ - ✓ - ✓ diff --git a/source/includes/libmongoc-compatibility-table-cxx.rst b/source/includes/libmongoc-compatibility-table-cxx.rst new file mode 100644 index 00000000..41e1029e --- /dev/null +++ b/source/includes/libmongoc-compatibility-table-cxx.rst @@ -0,0 +1,48 @@ +.. list-table:: + :header-rows: 1 + :stub-columns: 1 + :class: compatibility-large + + * - C++ Driver Version + - Minimum libmongoc Version + + * - 4.0.x + - 1.29.0 + + * - 3.11.x + - 1.28.0 + + * - 3.9.x and 3.10.x + - 1.25.0 + + * - 3.8.x + - 1.24.0 + + * - 3.7.x + - 1.22.1 + + * - 3.6.x + - 1.17.0 + + * - 3.5.x + - 1.15.0 + + * - 3.4.x + - 1.13.0 + + * - 3.3.x + - 1.10.0 + + * - 3.2.x + - 1.9.2 + + * - 3.1.4 + - 1.7.0 + + * - 3.1.0 to 3.1.3 + - 1.5.0 + + * - 3.0.1 to 3.0.3 + - 1.3.4 + * - 3.0.0 + - 1.3.1 \ No newline at end of file diff --git a/source/includes/mongodb-compatibility-table-cxx.rst b/source/includes/mongodb-compatibility-table-cxx.rst index 7fe0e462..1f39aa74 100644 --- a/source/includes/mongodb-compatibility-table-cxx.rst +++ b/source/includes/mongodb-compatibility-table-cxx.rst @@ -18,7 +18,7 @@ - MongoDB 2.6 - MongoDB 2.4 - * - 3.11 + * - 3.11 to 4.0 - ✓ - ✓ - ✓ diff --git a/source/index.txt b/source/index.txt index b661483f..d0e89698 100644 --- a/source/index.txt +++ b/source/index.txt @@ -165,10 +165,15 @@ For documentation about previous releases, see the `legacy documentation