From a7cfb1d83c7e0f97a806e1f2c202416e625b2ce2 Mon Sep 17 00:00:00 2001 From: David Waern Date: Tue, 11 May 2010 19:14:31 +0000 Subject: Re-organise the testsuite structure --- tests/golden-tests/README | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 tests/golden-tests/README (limited to 'tests/golden-tests/README') diff --git a/tests/golden-tests/README b/tests/golden-tests/README new file mode 100644 index 00000000..f538cea7 --- /dev/null +++ b/tests/golden-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 --xhtml all -- cgit v1.2.3