Pass -haddock to tests in should_compile_*flag*_nohaddock

should_compile_flag_nohaddock and should_compile_noflag_nohaddock
contain the exact same tests. By passing `-haddock` to the tests in
should_compile_**flag**_nohaddock, at least they're now testing
different things.

Add documentation.

5 files changed, 48 insertions, 4 deletions

diff --git a/testsuite/tests/haddock/should_compile_flag_haddock/all.T b/testsuite/tests/haddock/should_compile_flag_haddock/all.T
index a0d1d7c07d..344210e1a0 100644
--- a/testsuite/tests/haddock/should_compile_flag_haddock/all.T
+++ b/testsuite/tests/haddock/should_compile_flag_haddock/all.T
@@ -1,3 +1,12 @@
+# should_compile_flag_haddock.
+#
+# * flag: we *do* pass the -haddock flag
+#
+# * haddock: and tests *do* contain haddock annotations
+#
+# When adding a new test here, think about adding it to the
+# should_compile_noflag_haddock directory as well.
+
 test('haddockA001', normal, compile, ['-haddock -ddump-parsed'])
 test('haddockA002', normal, compile, ['-haddock -ddump-parsed'])
 test('haddockA003', normal, compile, ['-haddock -ddump-parsed'])
@@ -30,6 +39,10 @@ test('haddockA029', normal, compile, ['-haddock -ddump-parsed'])
 test('haddockA030', normal, compile, ['-haddock -ddump-parsed'])
 test('haddockA031', normal, compile, ['-haddock -ddump-parsed -XExistentialQuantification'])
 test('haddockA032', normal, compile, ['-haddock -ddump-parsed'])
+
+# The tests below this line are not duplicated in
+# should_compile_noflag_haddock.
+
 test('haddockA033', normal, compile, ['-haddock -ddump-parsed'])
 test('haddockA034', normal, compile, ['-haddock -ddump-parsed'])
 test('T10398', normal, compile, ['-haddock -ddump-parsed'])
diff --git a/testsuite/tests/haddock/should_compile_flag_nohaddock/all.T b/testsuite/tests/haddock/should_compile_flag_nohaddock/all.T
index 500a7e6bd1..b4c48573e6 100644
--- a/testsuite/tests/haddock/should_compile_flag_nohaddock/all.T
+++ b/testsuite/tests/haddock/should_compile_flag_nohaddock/all.T
@@ -1,4 +1,13 @@
-test('haddockB001', normal, compile, [''])
-test('haddockB002', normal, compile, [''])
-test('haddockB003', normal, compile, [''])
-test('haddockB004', normal, compile, [''])
+# should_compile_flag_nohaddock
+#
+# * flag: we *do* pass the -haddock flag
+#
+# * nohaddock: but tests do *not* contain haddock annotations
+#
+# When adding a new test here, think about adding it to the
+# should_compile_noflag_nohaddock directory as well.
+
+test('haddockB001', normal, compile, ['-haddock'])
+test('haddockB002', normal, compile, ['-haddock'])
+test('haddockB003', normal, compile, ['-haddock'])
+test('haddockB004', normal, compile, ['-haddock'])
diff --git a/testsuite/tests/haddock/should_compile_noflag_haddock/all.T b/testsuite/tests/haddock/should_compile_noflag_haddock/all.T
index 77aed59ba0..c0d62aed43 100644
--- a/testsuite/tests/haddock/should_compile_noflag_haddock/all.T
+++ b/testsuite/tests/haddock/should_compile_noflag_haddock/all.T
@@ -1,3 +1,12 @@
+# should_compile_noflag_haddock
+#
+# * noflag: we do *not* pass the -haddock flag
+#
+# * haddock: but tests *do* contain haddock annotations
+#
+# When adding a new test here, think about adding it to the
+# should_compile_flag_haddock directory as well.
+
 test('haddockC001', normal, compile, [''])
 test('haddockC002', normal, compile, [''])
 test('haddockC003', normal, compile, [''])
@@ -30,4 +39,8 @@ test('haddockC029', normal, compile, [''])
 test('haddockC030', normal, compile, [''])
 test('haddockC031', normal, compile, ['-XExistentialQuantification'])
 test('haddockC032', normal, compile, [''])
+
+# The tests below this line are not duplicated in
+# should_compile_flag_haddock.
+
 test('haddockSimplUtilsBug', normal, compile, [''])
diff --git a/testsuite/tests/haddock/should_compile_noflag_haddock/haddockSimplUtilsBug.stderr b/testsuite/tests/haddock/should_compile_noflag_haddock/haddockSimplUtilsBug.stderr
deleted file mode 100644
index e69de29bb2..0000000000
--- a/testsuite/tests/haddock/should_compile_noflag_haddock/haddockSimplUtilsBug.stderr
+++ /dev/null
diff --git a/testsuite/tests/haddock/should_compile_noflag_nohaddock/all.T b/testsuite/tests/haddock/should_compile_noflag_nohaddock/all.T
index 89c205b3ce..1c68255e1b 100644
--- a/testsuite/tests/haddock/should_compile_noflag_nohaddock/all.T
+++ b/testsuite/tests/haddock/should_compile_noflag_nohaddock/all.T
@@ -1,3 +1,12 @@
+# should_compile_noflag_nohaddock
+#
+# * noflag: we do *not* pass the -haddock flag
+#
+# * nohaddock: and tests do *not* contain haddock annotations
+#
+# When adding a new test here, think about adding it to the
+# should_compile_flag_nohaddock directory as well.
+
 test('haddockD001', normal, compile, [''])
 test('haddockD002', normal, compile, [''])
 test('haddockD003', normal, compile, [''])