summaryrefslogtreecommitdiff
path: root/testsuite
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2022-01-30 08:45:49 -0500
committerMarge Bot <ben+marge-bot@smart-cactus.org>2022-02-01 12:29:26 -0500
commit88fba8a4b3c22e953a634b81dd0b67ec66eb5e72 (patch)
tree75a46332ad32cfeaf4f4d52b3b60fd452f2493b6 /testsuite
parent06185102bb06d6d56e00d40172a6a473fc228501 (diff)
downloadhaskell-88fba8a4b3c22e953a634b81dd0b67ec66eb5e72.tar.gz
Fix a few Note inconsistencies
Diffstat (limited to 'testsuite')
-rw-r--r--testsuite/driver/runtests.py2
-rw-r--r--testsuite/driver/testlib.py7
-rw-r--r--testsuite/mk/boilerplate.mk4
-rw-r--r--testsuite/mk/test.mk2
-rw-r--r--testsuite/tests/perf/haddock/all.T2
-rw-r--r--testsuite/tests/stranal/sigs/T19871.hs2
6 files changed, 10 insertions, 9 deletions
diff --git a/testsuite/driver/runtests.py b/testsuite/driver/runtests.py
index 00564a48dc..219fb41001 100644
--- a/testsuite/driver/runtests.py
+++ b/testsuite/driver/runtests.py
@@ -601,7 +601,7 @@ else:
cleanup_and_exit(exitcode)
# Note [Running tests in /tmp]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Use LOCAL=0 to run tests in /tmp, to catch tests that use files from
# the source directory without copying them to the test directory first.
#
diff --git a/testsuite/driver/testlib.py b/testsuite/driver/testlib.py
index 6b6462f527..423cd99313 100644
--- a/testsuite/driver/testlib.py
+++ b/testsuite/driver/testlib.py
@@ -992,6 +992,7 @@ def test(name: TestName,
return
else:
# Note [Mutating config.only]
+ # ~~~~~~~~~~~~~~~~~~~~~~~~~~~
# config.only is initially the set of tests requested by
# the user (via 'make TEST='). We then remove all tests that
# we've already seen (in .T files), so that we can later
@@ -2006,7 +2007,7 @@ def write_file(f: Path, s: str) -> None:
h.write(s)
# Note [Universal newlines]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~
# We don't want to write any Windows style line endings ever, because
# it would mean that `make accept` would touch every line of the file
# when switching between Linux and Windows.
@@ -2202,7 +2203,7 @@ def grep_output(normaliser: OutputNormalizer, pattern_file, actual_file, is_subs
return success
# Note [Output comparison]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~
# We do two types of output comparison:
#
# 1. To decide whether a test has failed. We apply a `normaliser` and an
@@ -2218,7 +2219,7 @@ def grep_output(normaliser: OutputNormalizer, pattern_file, actual_file, is_subs
# possible (#10152).
# Note [Null device handling]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~
# On windows the null device is 'nul' instead of '/dev/null'.
# This can in principle be easily solved by using os.devnull.
# Not doing so causes issues when python tries to read/write/open
diff --git a/testsuite/mk/boilerplate.mk b/testsuite/mk/boilerplate.mk
index 9b66ee1d1e..c3be669636 100644
--- a/testsuite/mk/boilerplate.mk
+++ b/testsuite/mk/boilerplate.mk
@@ -50,7 +50,7 @@ endef
ifeq "$(TEST_HC)" ""
# Note [Spaces in TEST_HC]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~
# Tests should be able to handle paths with spaces.
#
# One of the things ./validate (without --fast) does is check if binary
@@ -128,7 +128,7 @@ endif
IN_TREE_COMPILER = NO
# Note [The TEST_HC variable]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~
# As values of TEST_HC passed in by the user, we want to support:
# * both "ghc" and "/usr/bin/ghc"
# We use 'which' to convert the former to the latter.
diff --git a/testsuite/mk/test.mk b/testsuite/mk/test.mk
index 483d17c051..e01a76eb29 100644
--- a/testsuite/mk/test.mk
+++ b/testsuite/mk/test.mk
@@ -384,7 +384,7 @@ list_broken:
$(MAKE) list_broken=YES
# Note [Communicating options and variables to a submake]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Consider the following scenario:
# * A test foo is defined as
# test('foo', [], run_command, ['$MAKE footarget'])
diff --git a/testsuite/tests/perf/haddock/all.T b/testsuite/tests/perf/haddock/all.T
index 5e90fd05a3..e2f3346898 100644
--- a/testsuite/tests/perf/haddock/all.T
+++ b/testsuite/tests/perf/haddock/all.T
@@ -1,5 +1,5 @@
# Note [Haddock runtime stats files]
-#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# When one of the build systems builds a complete GHC distribution,
# haddock gets built and then used to generate .haddock files for each
# library. For that last step, both build systems pass an extra
diff --git a/testsuite/tests/stranal/sigs/T19871.hs b/testsuite/tests/stranal/sigs/T19871.hs
index 564a055df4..ac9e813836 100644
--- a/testsuite/tests/stranal/sigs/T19871.hs
+++ b/testsuite/tests/stranal/sigs/T19871.hs
@@ -1,6 +1,6 @@
{-# OPTIONS_GHC -O2 -fforce-recomp #-}
--- | From Note [Boxity Analysis] and related Notes
+-- | From Note [Boxity analysis] and related Notes
module T19871 where
data Huge