aboutsummaryrefslogtreecommitdiff
path: root/tests/golden-tests/README
diff options
context:
space:
mode:
authorDavid Waern <david.waern@gmail.com>2010-12-06 14:25:37 +0000
committerDavid Waern <david.waern@gmail.com>2010-12-06 14:25:37 +0000
commitb89b21a6d75c5498d4ebc19e8d099c1b91c44182 (patch)
tree127987ec9edbf0ca516d82912b93de45e7d1461e /tests/golden-tests/README
parent650058aceba7a07192cf4e1792e2b24f636dcc31 (diff)
Rename golden-tests into html-tests. "golden tests" sounds strange
Diffstat (limited to 'tests/golden-tests/README')
-rw-r--r--tests/golden-tests/README28
1 files changed, 0 insertions, 28 deletions
diff --git a/tests/golden-tests/README b/tests/golden-tests/README
deleted file mode 100644
index fd906b2b..00000000
--- a/tests/golden-tests/README
+++ /dev/null
@@ -1,28 +0,0 @@
-
-This is a testsuite for Haddock that uses the concept of "golden files". That
-is, it compares output files against a set of reference files.
-
-To add a new test:
-
- 1) Create a module in the "tests" directory.
-
- 2) Run runtests.hs. You should now have output/<modulename>.html. The test
- passes since there is no reference file to compare with.
-
- 3) To make a reference file from the output file, do
- runhaskell copy.hs <modulename>
-
-Tips and tricks:
-
-You can
- runhaskell copy.hs
-
-to copy all output files into reference files.
-
-You can
- runhaskell runtests.hs all
-
-to continue despite a failing test.
-
-You can pass extra options to haddock like so
- runhaskell runtests.hs --title="All Tests" all