From 612b31790c4d486a8124133355e0854c89ce8e48 Mon Sep 17 00:00:00 2001 From: Saghm Rossi Date: Fri, 14 Apr 2017 18:03:32 -0400 Subject: [PATCH] CXX-1304 CXX-1304 Document std::experimental polyfill as unsupported --- docs/content/mongocxx-v3/installation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/content/mongocxx-v3/installation.md b/docs/content/mongocxx-v3/installation.md index dc4cf579de..e27378746a 100644 --- a/docs/content/mongocxx-v3/installation.md +++ b/docs/content/mongocxx-v3/installation.md @@ -57,7 +57,10 @@ implementations for these features: Select with `-DBSONCXX_POLY_USE_STD_EXPERIMENTAL=1`. If your toolchain's standard library provides `optional` and `string_view` in the namespace `std::experimental`, you can use - this option. + this option. Be aware that your standard library's + `std::experimental` implementation may change over time, + breaking binary compatibility in unexpected ways. Note that this + polyfill is *not* recommended and is unsupported. Most users should be fine sticking with the default. However, if you have an existing application which makes heavy use of one of the @@ -67,9 +70,6 @@ against the same library. **DO NOT** change your project's polyfill if you need to create a stable binary interface. -Be aware that your standard library's `std::experimental` implementation -may change over time, breaking binary compatibility in unexpected ways. - ### Step 3: Download the latest version of the mongocxx driver. To get the source via git, the `releases/stable` branch will track the most