Skip to content

Commit a6db059

Browse files
committed
Update Build::cpp documentation, remove documentation link to non-public function
1 parent 608ad0c commit a6db059

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/lib.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,12 @@ impl Build {
592592
///
593593
/// The other `cpp_*` options will only become active if this is set to
594594
/// `true`.
595+
///
596+
/// The name of the C++ standard library to link is decided by:
597+
/// 1. If [cpp_link_stdlib](Build::cpp_link_stdlib) is set, use its value.
598+
/// 2. Else if the `CXXSTDLIB` environment variable is set, use its value.
599+
/// 3. Else the default is `libc++` for OS X and BSDs, `libc++_shared` for Android,
600+
/// `None` for MSVC and `libstdc++` for anything else.
595601
pub fn cpp(&mut self, cpp: bool) -> &mut Build {
596602
self.cpp = cpp;
597603
self
@@ -684,8 +690,6 @@ impl Build {
684690
/// Set the standard library to link against when compiling with C++
685691
/// support.
686692
///
687-
/// See [`get_cpp_link_stdlib`](cc::Build::get_cpp_link_stdlib) documentation
688-
/// for the default value.
689693
/// If the `CXXSTDLIB` environment variable is set, its value will
690694
/// override the default value, but not the value explicitly set by calling
691695
/// this function.

0 commit comments

Comments
 (0)