DOCSP-50761 Add minimum compiler versions to build from source #140
Conversation
✅ Deploy Preview for docs-cpp ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🔄 Deploy Preview for docs-cpp processing
|
source/get-started.txt
Outdated
| - `GCC <https://gcc.gnu.org/install/>`__ v8.1 or newer | ||
| - `Clang <https://clang.llvm.org/>`__ v3.8 or newer | ||
| - `Apple Clang <https://developer.apple.com/xcode/>`__ v13.1 or newer | ||
| - `Visual Studio <https://visualstudio.microsoft.com/vs/features/cplusplus/>`__ 2015 Update 3 or newer |
There was a problem hiding this comment.
S: I'd use "later" instead of "newer":
| - `GCC <https://gcc.gnu.org/install/>`__ v8.1 or newer | |
| - `Clang <https://clang.llvm.org/>`__ v3.8 or newer | |
| - `Apple Clang <https://developer.apple.com/xcode/>`__ v13.1 or newer | |
| - `Visual Studio <https://visualstudio.microsoft.com/vs/features/cplusplus/>`__ 2015 Update 3 or newer | |
| - `GCC <https://gcc.gnu.org/install/>`__ v8.1 or later | |
| - `Clang <https://clang.llvm.org/>`__ v3.8 or later | |
| - `Apple Clang <https://developer.apple.com/xcode/>`__ v13.1 or later | |
| - `Visual Studio <https://visualstudio.microsoft.com/vs/features/cplusplus/>`__ 2015 Update 3 or later |
source/get-started.txt
Outdated
| - Compiler that supports C++17, such as one of the following: | ||
|
|
||
| - `GCC <https://gcc.gnu.org/install/>`__ v8.1 or later | ||
| - `Clang <https://clang.llvm.org/>`__ v3.8 or later | ||
| - `Apple Clang <https://developer.apple.com/xcode/>`__ v13.1 or later | ||
| - `Visual Studio <https://visualstudio.microsoft.com/vs/features/cplusplus/>`__ 2015 Update 3 or later | ||
|
|
There was a problem hiding this comment.
The current wording conflates the new minimum required compiler versions, which require support for C++11 and newer, with the C++17 requirement that is relevant only for this tutorial page (although it is still recommended over using C++11). Most of these compiler versions Clang 3.8 and VS 2015 do not support C++17.
Suggest moving the list of "minimum required compiler versions" into a separate note into the "Compatibility" page and referencing that page within the existing "Pre-C++17 Configurations" note below.
|
Note: rather than the "Get Started" page, these minimum required compiler versions should probably be listed on the "Compatibility" page under a "Compilers" section in a manner similar to what is already done for the C Driver, although I'd prefer the description be "The currently supported list of compilers are: ..." rather than "The following compilers are continually tested with ...: ...". |
|
Appreciate the suggestion @eramongodb! I moved this into the compatibility page instead and modified the intro wording a bit |
| * - Compiler | ||
| - Version | ||
|
|
||
| * - `GCC <https://gcc.gnu.org/install/>`__ |
There was a problem hiding this comment.
| * - `GCC <https://gcc.gnu.org/install/>`__ | |
| * - `GCC <https://gcc.gnu.org/>`__ |
Main page rather than install page.
| * - `Clang <https://clang.llvm.org/>`__ | ||
| - v3.8 or later | ||
|
|
||
| * - `Apple Clang <https://developer.apple.com/xcode/>`__ |
There was a problem hiding this comment.
| * - `Apple Clang <https://developer.apple.com/xcode/>`__ | |
| * - `Xcode 13.4 <https://developer.apple.com/xcode/cpp/>`__ |
Given Xcode (IDE) provides Apple Clang (compiler) similar to how Visual Studio (IDE) provides MSVC (compiler), recommend better consistency between both by opting for the name and version of the IDE rather than the compiler.
|
|
||
| The preceding compiler versions are the minimum versions required to | ||
| build the {+driver-short+} from source. These are not requirements | ||
| needed for prebuilt headers and libraries. |
There was a problem hiding this comment.
| needed for prebuilt headers and libraries. | |
| to use prebuilt headers and libraries. |
Wording tweak.
(cherry picked from commit 7ed65c8)
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-50761
Staging Links
Self-Review Checklist