-
Notifications
You must be signed in to change notification settings - Fork 543
CXX-2579 use standard directories in main install instructions #944
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
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
And explain rationale. This can help a consumer locate libbsoncxx.so if the consumer only links to full path of libmongocxx.so.
To prevent requiring users to have additional permissions. Installing to `/opt` on macOS requires root permissions.
rcsanchez97
approved these changes
Mar 20, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
eramongodb
reviewed
Mar 21, 2023
Co-authored-by: Ezra Chung <[email protected]>
The instructions are no longer platform specific.
eramongodb
approved these changes
Mar 21, 2023
vector-of-bool
approved these changes
Mar 28, 2023
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.
Description
This PR changes the main installation instructions to use standard directories. Installing to non-standard directories, as well as common fixes to failures to load libraries, have been moved to the "Advanced Configuration and Installation Options" instructions.
Documentation can be locally built with
cmake --build cmake-build --target hugo
.Use standard install directories in main installation instructions
The error described in CXX-2579 is due to the runtime loader being unable to find the C++ driver libraries.
IMO installing to non-standard directories is not a common enough use case to add to the main installation instructions.
The C driver Unix install instructions do not set
CMAKE_INSTALL_PREFIX
.A section named
Installing to non-standard directories
has been added to theAdvanced Configuration and Installation Options
page.Add instructions for fixes to locate shared libraries
To assist users encountering errors locating shared libraries, suggested solutions were added to the "Advanced Configuration and Installation Options".
Solutions for the "Library not loaded" error on macOS were tested here.
Solutions for the "cannot open shared object file" error on Linux were tested here.
https://www.mikeash.com/pyblog/friday-qa-2009-11-06-linking-and-install-names.html suggests that application is responsible for adding paths to load:
https://www.dribin.org/dave/blog/archives/2009/11/15/rpath/ also suggests this:
Other improvements
/opt/
with$HOME
in non-standard directory install instructions. Installing to/opt
may be more likely to require root permissions./lib
inCMAKE_INSTALL_RPATH
instruction.