Skip to content

Commit

Permalink
Update Build::cpp documentation, remove documentation link to non-pub…
Browse files Browse the repository at this point in the history
…lic function
  • Loading branch information
SallySoul committed May 21, 2021
1 parent 608ad0c commit 53a3741
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/lib.rs
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

0 comments on commit 53a3741

Please sign in to comment.