testsuite/README.md

   1 GHC Testsuite Readme
   2 ====================
   3
   4 For the full testsuite documentation, please see [here][1].
   5
   6 ## Quick Guide
   7
   8 Commands to run testsuite:
   9
  10  * Full testsuite: `make`
  11  * Using more threads: `make THREADS=12`
  12  * Reduced (fast) testsuite: `make fast`
  13  * Run a specific test: `make TEST=tc054`
  14  * Test a specific 'way': `make WAY=optllvm`
  15  * Test a specifc stage of GHC: `make stage=1`
  16  * Skip performance tests: `make SKIP_PERF_TESTS=YES`
  17  * Set verbosity: `make VERBOSE=n`
  18    where n=0: No per-test ouput, n=1: Only failures,
  19          n=2: Progress output, n=3: Include commands called (default)
  20  * Pass in extra GHC options: `make EXTRA_HC_OPTS=-fvectorize`
  21
  22 You can also change directory to a specific test folder to run that
  23 individual test or group of tests. For example:
  24
  25 ``` .sh
  26 $ cd tests/array
  27 $ make
  28 ```
  29
  30 ## Testsuite Ways
  31
  32 The testsuite can be run in a variety of 'ways'. This concept refers
  33 to different ways that GHC can compile the code. For example, using
  34 the native code generator (`-fasm`) is one way, while using the LLVM
  35 code generator (`-fllvm`) is another way.
  36
  37 The various ways that GHC supports are defined in `config/ghc`
  38
  39 ## Adding Tests
  40
  41 Please see the more extensive documentation [here][1].
  42
  43   [1]: http://hackage.haskell.org/trac/ghc/wiki/Building/RunningTests