nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-22 06:44:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Compiler test manual

Browse Source
This commit is contained in:
christopherdumas 2015-09-12 08:02:01 -07:00
parent 3f86602e00
commit d09ba5d3ce
2 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
COMPILER_TESTS.md Normal file
View File

@ -0,0 +1,43 @@
# Compiler Test Documentation
In the Rust project, we use a special set of comands imbedded in
comments to test the Rust compiler. There are two groups of commands:
1. Header commands
2. 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:
1. `ERROR`
2. `WARNING`
3. `NOTE`
4. `HELP` and `SUGGESTION`*
\* **Note**: `SUGGESTION` must follow emediatly 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` where `X` is an architecture, OS or stage will ignore the test accordingly
* `ignore-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 test
* `ignore-lldb` and `ignore-gdb` will skip the debuginfo tests
* `min-{gdb,lldb}-version`

2
CONTRIBUTING.md
View File

@ -224,6 +224,7 @@ are:
* The [rust referance][rr], even though it doesn't specifically talk about Rust's internals, its a great reasource nontheless
* Although out of date, [Tom Lee's great blog article][tlgba] is very helpful
* [rustaceans.org][ro] is helpful, but mostly dedicated to IRC
* The [Rust Compiler Testing Docs][rctd]
* **Google**!
* Don't be afraid to ask! The Rust community is friendly and helpful.
@ -232,3 +233,4 @@ are:
[rr]: https://doc.rust-lang.org/book/README.html
[tlgba]: http://tomlee.co/2014/04/03/a-more-detailed-tour-of-the-rust-compiler/
[ro]: http://www.rustaceans.org/
[rctd]: ./COMPILER_TESTS.md