Skip to content

Commit

Permalink
CXX-1304 CXX-1304 Document std::experimental polyfill as unsupported
Browse files Browse the repository at this point in the history
  • Loading branch information
saghm committed Apr 14, 2017
1 parent 6a0218e commit 612b317
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/content/mongocxx-v3/installation.md
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 612b317

Please sign in to comment.