Skip to content
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.

Sign up for GitHub

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

Improve docs for the C++ usage #600

Merged
merged 1 commit into from
Apr 24, 2023
Merged

Improve docs for the C++ usage #600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,12 @@ impl Build {
///
/// The other `cpp_*` options will only become active if this is set to
/// `true`.
///
/// The name of the C++ standard library to link is decided by:
/// 1. If [cpp_link_stdlib](Build::cpp_link_stdlib) is set, use its value.
/// 2. Else if the `CXXSTDLIB` environment variable is set, use its value.
/// 3. Else the default is `libc++` for OS X and BSDs, `libc++_shared` for Android,
/// `None` for MSVC and `libstdc++` for anything else.
pub fn cpp(&mut self, cpp: bool) -> &mut Build {
self.cpp = cpp;
self
Expand Down Expand Up @@ -684,8 +690,6 @@ impl Build {
/// Set the standard library to link against when compiling with C++
/// support.
///
/// See [`get_cpp_link_stdlib`](cc::Build::get_cpp_link_stdlib) documentation
/// for the default value.
/// If the `CXXSTDLIB` environment variable is set, its value will
/// override the default value, but not the value explicitly set by calling
/// this function.
Expand Down