Skip to content

Commit d7c7610

Browse files
committed
Separate examples of what to do from examples of what not to do
1 parent 856f13d commit d7c7610

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

src/building/bootstrapping.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,18 @@ The convention `x.py` uses is that:
139139
- `x.py build --stage 0` means to build with the beta `rustc`.
140140
- `x.py doc --stage 0` means to document using the beta `rustdoc`.
141141
- `x.py test --stage 0 library/std` means to run tests on the standard library
142-
without building `rustc` from source ('build with stage 0, then test the artifacts').
142+
without building `rustc` from source ('build with stage 0, then test the
143+
artifacts'). If you're working on the standard library, this is normally the
144+
test command you want.
145+
- `x.py test src/test/ui` means to build the stage 1 compiler and run
146+
`compiletest` on it. If you're working on the compiler, this is normally the
147+
test command you want.
148+
149+
#### Non-examples
150+
143151
- `x.py test --stage 0 src/test/ui` is not meaningful: it runs tests on the
144152
_beta_ compiler and doesn't build `rustc` from source. Use `test src/test/ui`
145-
instead, which builds from source.
153+
instead, which builds stage 1 from source.
146154
- `x.py test --stage 0 compiler/rustc` builds the compiler but runs no tests:
147155
it's running `cargo test -p rustc`, but cargo doesn't understand Rust's
148156
tests. You shouldn't need to use this, use `test` instead (without arguments).

0 commit comments

Comments
 (0)