Skip to content

Commit 41c61ca

Browse files
committed
mark test suite as deprecated
1 parent 9c0daca commit 41c61ca

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

test-suite.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ title: The Rust Test Suite · The Rust Programming Language
55

66
# The Rust test suite
77

8+
## THIS DOCUMENT IS DEPRECATED. PLEASE READ src/test/COMPILER_TESTS.md IN THE COMPILER REPO INSTEAD
9+
810
The rust test suite has several sets of tests for different purposes. As the compiler is built over multiple stages, and with varying host and target combinations, debugging and profiling settings, the tests can be run in many different ways.
911

1012
## Recipes
@@ -120,7 +122,7 @@ fn main() {
120122
```
121123

122124
In fact, this test would fail, because there are two errors: the type
123-
mismatch and the undefined variable `b`.
125+
mismatch and the undefined variable `b`.
124126

125127
Sometimes it is not possible or not convenient to place the `//~`
126128
comment on precisely the line where the error occurs. For those cases,
@@ -143,7 +145,7 @@ fn main() {
143145
The older technique for specifying error messages was to use an
144146
`error-pattern` directive. These directives are placed at the top of
145147
the file and each message found in an `error-pattern` directive must
146-
appear in the output.
148+
appear in the output.
147149

148150
Using error comments is preferred, however, because it is a more
149151
thorough test:
@@ -153,7 +155,7 @@ thorough test:
153155

154156
### Multi-crate testing
155157

156-
Sometimes it is useful to write tests that make use of more than one crate. We have limited support for this scenario. Basically, you can write and add modules into the `src/test/auxiliary` directory. These files are not built nor tested directly. Instead, you write a main test in one of the other directories (`run-pass`, `compile-fail`, etc) and add a `aux-build` directive at the head of the main test. When running the main test, the test framework will build the files it is directed to build from the auxiliary directory. These builds *must* succeed or the test will fail. You can then include `use` and `import` commands to make use of the byproducts from these builds as you wish.
158+
Sometimes it is useful to write tests that make use of more than one crate. We have limited support for this scenario. Basically, you can write and add modules into the `src/test/auxiliary` directory. These files are not built nor tested directly. Instead, you write a main test in one of the other directories (`run-pass`, `compile-fail`, etc) and add a `aux-build` directive at the head of the main test. When running the main test, the test framework will build the files it is directed to build from the auxiliary directory. These builds *must* succeed or the test will fail. You can then include `use` and `import` commands to make use of the byproducts from these builds as you wish.
157159

158160
An example consisting of two files:
159161

0 commit comments

Comments
 (0)