mirror of
https://github.com/rust-lang/rust
synced 2024-09-05 00:24:52 +00:00
1.5 KiB
1.5 KiB
Compiler Test Documentation
In the Rust project, we use a special set of commands embedded in comments to test the Rust compiler. There are two groups of commands:
- Header commands
- Error info commands
Both types of commands are inside comments, but header commands should be in a comment before any code.
Summary of Error Info Commands
Error commands specify something about certain lines of the program. They tell the test what kind of error and what message you are expecting.
~
: Associates the following error level and message with the current line~|
: Associates the following error level and message with the same line as the previous comment~^
: Associates the following error level and message with the previous line. Each caret (^
) that you add adds a line to this, so~^^^^^^^
is seven lines up.
The error levels that you can have are:
ERROR
WARNING
NOTE
HELP
andSUGGESTION
*
* Note: SUGGESTION
must follow immediately after HELP
.
Summary of Header Commands
Header commands specify something about the entire test file as a whole, instead of just a few lines inside the test.
ignore-X
whereX
is an architecture, OS or stage will ignore the test accordinglyignore-pretty
will not compile the pretty-printed test (this is done to test the pretty-printer, but might not always work)ignore-test
always ignores the testignore-lldb
andignore-gdb
will skip the debuginfo testsmin-{gdb,lldb}-version