From: kennytm <kennytm@gmail.com>
Date: Sat, 5 May 2018 19:29:19 +0000 (+0800)
Subject: Added some simple documentation.
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=169f58b712e793ea43b90a6008a21b777bf4102f;p=rust.git

Added some simple documentation.
---

diff --git a/src/bootstrap/README.md b/src/bootstrap/README.md
index 9ff681ac680..98c353eb6ec 100644
--- a/src/bootstrap/README.md
+++ b/src/bootstrap/README.md
@@ -64,6 +64,10 @@ The script accepts commands, flags, and arguments to determine what to do:
   # execute tests in the standard library in stage0
   ./x.py test --stage 0 src/libstd
 
+  # execute tests in the core and standard library in stage0,
+  # without running doc tests (thus avoid depending on building the compiler)
+  ./x.py test --stage 0 --no-doc src/libcore src/libstd
+
   # execute all doc tests
   ./x.py test src/doc
   ```
diff --git a/src/libcore/lib.rs b/src/libcore/lib.rs
index 37f9dcc7e32..54f35d17974 100644
--- a/src/libcore/lib.rs
+++ b/src/libcore/lib.rs
@@ -50,6 +50,14 @@
 
 // Since libcore defines many fundamental lang items, all tests live in a
 // separate crate, libcoretest, to avoid bizarre issues.
+//
+// Here we explicitly #[cfg]-out this whole crate when testing. If we don't do
+// this, both the generated test artifact and the linked libtest (which
+// transitively includes libcore) will both define the same set of lang items,
+// and this will cause the E0152 "duplicate lang item found" error. See
+// discussion in #50466 for details.
+//
+// This cfg won't affect doc tests.
 #![cfg(not(test))]
 
 #![stable(feature = "core", since = "1.6.0")]