diff options
author | David Terei <davidterei@gmail.com> | 2013-06-06 12:06:27 -0700 |
---|---|---|
committer | David Terei <davidterei@gmail.com> | 2013-06-06 12:06:27 -0700 |
commit | 09de957806b7f23d5d528da8ec867582541dac2b (patch) | |
tree | 8e31bfeee4ca1b579a73eca83fa7a69fce0f9a52 /testsuite/README.md | |
parent | cc1b579ee4e0831844184222c3f666a371808f74 (diff) | |
download | haskell-09de957806b7f23d5d528da8ec867582541dac2b.tar.gz |
Update readme to markdown and expand.
Diffstat (limited to 'testsuite/README.md')
-rw-r--r-- | testsuite/README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/testsuite/README.md b/testsuite/README.md new file mode 100644 index 0000000000..9b52e305a5 --- /dev/null +++ b/testsuite/README.md @@ -0,0 +1,39 @@ +GHC Testsuite Readme +==================== + +For the full testsuite documentation, please see [here][1]. + +## Quick Guide + +Commands to run testsuite: + + * Full testsuite: `make` + * Using more threads: `make THREADS=12` + * Reduced (fast) testsuite: `make fast` + * Run a specific test: `make TEST=tc054` + * Test a specific 'way': `make WAY=optllvm` + * Test a specifc stage of GHC: `make stage=1` + * Pass in extra GHC options: `make EXTRA_HC_OPTS=-fvectorize` + +You can also change directory to a specific test folder to run that +individual test or group of tests. For example: + +``` .sh +$ cd tests/array +$ make +``` + +## Testsuite Ways + +The testsuite can be run in a variety of 'ways'. This concept refers +to different ways that GHC can compile the code. For example, using +the native code generator (`-fasm`) is one way, while using the LLVM +code generator (`-fllvm`) is another way. + +The various ways that GHC supports are defined in `config/ghc` + +## Adding Tests + +Please see the more extensive documentation [here][1]. + + [1]: http://hackage.haskell.org/trac/ghc/wiki/Building/RunningTests |