From b89b21a6d75c5498d4ebc19e8d099c1b91c44182 Mon Sep 17 00:00:00 2001 From: David Waern Date: Mon, 6 Dec 2010 14:25:37 +0000 Subject: Rename golden-tests into html-tests. "golden tests" sounds strange --- tests/html-tests/README | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 tests/html-tests/README (limited to 'tests/html-tests/README') diff --git a/tests/html-tests/README b/tests/html-tests/README new file mode 100644 index 00000000..fd906b2b --- /dev/null +++ b/tests/html-tests/README @@ -0,0 +1,28 @@ + +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/.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 + +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 -- cgit v1.2.3