SWIFT-696 Update installation instructions to mention required system libraries #405
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
patrickfreed
commented
Feb 14, 2020
| ### Step 1: Install the MongoDB C Driver | ||
| The driver wraps the MongoDB C driver, and using it requires having the C driver's two components, `libbson` and `libmongoc`, installed on your system. **The minimum required version of the C Driver is 1.15.3**. | ||
| ### Step 1: Install required system libraries (Linux Only) | ||
| The driver vendors and wraps the MongoDB C driver (`libmongoc`), which depends on a number of external C libraries when built in Linux environments. As a result, these libraries must be installed on your system in order to build MongoSwift. |
Contributor
Author
There was a problem hiding this comment.
I decided to just keep relying on libmongoc's instructions so that we don't have to update this all the time. The one caveat with that is that it includes cmake as a dependency, which isn't necessary for us. That doesn't seem like too big of a deal to me though.
|
|
||
| ### Step 1: Install the MongoDB C Driver | ||
| The driver wraps the MongoDB C driver, and using it requires having the C driver's two components, `libbson` and `libmongoc`, installed on your system. **The minimum required version of the C Driver is 1.15.3**. | ||
| ### Step 1: Install required system libraries (Linux Only) |
Contributor
Author
There was a problem hiding this comment.
libmongoc only lists dependencies for linux, since I think the tls stuff is built into SecureTransport and macos appears to ship with sasl2.
patrickfreed
changed the title
kmahar
approved these changes
Feb 14, 2020
Contributor
kmahar
left a comment
kmahar
left a comment
There was a problem hiding this comment.
LGTM, but instead of merging this into master can you merge it into 1.0.0-rc-changes? and then just before the release we can merge that branch into master
kmahar
pushed a commit
that referenced
this pull request
Feb 20, 2020
kmahar
pushed a commit
that referenced
this pull request
Feb 21, 2020
kmahar
pushed a commit
that referenced
this pull request
Feb 26, 2020
kmahar
pushed a commit
that referenced
this pull request
Feb 27, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SWIFT-696