COMPILER_TESTS.md

   1 # Compiler Test Documentation
   2
   3 In the Rust project, we use a special set of commands embedded in
   4 comments to test the Rust compiler. There are two groups of commands:
   5
   6 1. Header commands
   7 2. Error info commands
   8
   9 Both types of commands are inside comments, but header commands should
  10 be in a comment before any code.
  11
  12 ## Summary of Error Info Commands
  13
  14 Error commands specify something about certain lines of the
  15 program. They tell the test what kind of error and what message you
  16 are expecting.
  17
  18 * `~`: Associates the following error level and message with the
  19   current line
  20 * `~|`: Associates the following error level and message with the same
  21   line as the previous comment
  22 * `~^`: Associates the following error level and message with the
  23   previous line. Each caret (`^`) that you add adds a line to this, so
  24   `~^^^^^^^` is seven lines up.
  25
  26 The error levels that you can have are:
  27
  28 1. `ERROR`
  29 2. `WARNING`
  30 3. `NOTE`
  31 4. `HELP` and `SUGGESTION`*
  32
  33 \* **Note**: `SUGGESTION` must follow immediately after `HELP`.
  34
  35 ## Summary of Header Commands
  36
  37 Header commands specify something about the entire test file as a
  38 whole, instead of just a few lines inside the test.
  39
  40 * `ignore-X` where `X` is an architecture, OS or stage will ignore the test accordingly
  41 * `ignore-pretty` will not compile the pretty-printed test (this is done to test the pretty-printer, but might not always work)
  42 * `ignore-test` always ignores the test
  43 * `ignore-lldb` and `ignore-gdb` will skip the debuginfo tests
  44 * `min-{gdb,lldb}-version`