aboutsummaryrefslogtreecommitdiff
path: root/html-test/README.markdown
diff options
context:
space:
mode:
authorKazu Yamamoto <kazu@iij.ad.jp>2013-02-01 11:59:24 +0900
committerKazu Yamamoto <kazu@iij.ad.jp>2013-02-01 11:59:24 +0900
commit8d4c94ca5a969a5ebbb791939fb0195dc672429e (patch)
tree560a944a7105cd715f9acba46790bd7e1a77f82f /html-test/README.markdown
parent266a20afd2d27f28bbb62839ebc3f70bd83bfcce (diff)
parent3d25ea2929a9a9bd0768339b8ac5fd1b7c4670ad (diff)
Merge branch 'ghc-7.6' into ghc-7.6-merge-2
Conflicts: haddock.cabal src/Haddock/Interface/AttachInstances.hs src/Haddock/Interface/Create.hs src/Haddock/Interface/LexParseRn.hs src/Haddock/InterfaceFile.hs src/Haddock/Types.hs Only GHC HEAD can compile this. GHC 7.6.x cannot compile this. Some test fail.
Diffstat (limited to 'html-test/README.markdown')
-rw-r--r--html-test/README.markdown27
1 files changed, 27 insertions, 0 deletions
diff --git a/html-test/README.markdown b/html-test/README.markdown
new file mode 100644
index 00000000..8d57acab
--- /dev/null
+++ b/html-test/README.markdown
@@ -0,0 +1,27 @@
+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 `html-test/src` directory.
+
+ 2. Run `cabal test`. You should now have `html-test/out/<modulename>.html`.
+ The test passes since there is no reference file to compare with.
+
+ 3. To make a reference file from the output file, run
+
+ html-test/accept.lhs <modulename>
+
+Tips and tricks:
+
+To "accept" all output files (copy them to reference files), run
+
+ runhaskell accept.lhs
+
+You can run all tests despite failing tests, like so
+
+ cabal test --test-option=all
+
+You can pass extra options to haddock like so
+
+ cabal test --test-options='all --title="All Tests"'