From 4570319fc2631c97490a337242a3b6c50f3072e4 Mon Sep 17 00:00:00 2001
From: Jacco Krijnen <j.o.g.krijnen@uu.nl>
Date: Tue, 11 Jun 2024 18:53:32 +0200
Subject: [PATCH] Document how to run haddocks tests (#24976)
Also remove ghc 9.7 requirement
---
utils/haddock/CONTRIBUTING.md | 11 +++++++++++
utils/haddock/cabal.project | 2 --
2 files changed, 11 insertions(+), 2 deletions(-)
diff --git a/utils/haddock/CONTRIBUTING.md b/utils/haddock/CONTRIBUTING.md
index eccc51fdf5ab..bd8b0acf13cc 100644
--- a/utils/haddock/CONTRIBUTING.md
+++ b/utils/haddock/CONTRIBUTING.md
@@ -28,6 +28,17 @@ Then, run the following command from the top-level:
$ ./hadrian/build -j --flavour=Quick --freeze1 _build/stage1/bin/haddock
```
+### Running the test suites
+
+Currently, this cannot be done with hadrian but has to be done with a
+`cabal-install` built from `master`.
+
+```
+cabal test -w <absolute-path-to-ghc-repo>/_build/stage1/bin/ghc
+```
+
+For more details, see https://gitlab.haskell.org/ghc/ghc/-/issues/24976.
+
## Working with the codebase
The project provides a Makefile with rules to accompany you during development:
diff --git a/utils/haddock/cabal.project b/utils/haddock/cabal.project
index 28290fd794e8..426ca8283700 100644
--- a/utils/haddock/cabal.project
+++ b/utils/haddock/cabal.project
@@ -1,5 +1,3 @@
-with-compiler: ghc-9.7
-
packages: ./
./haddock-api
./haddock-library
--
GitLab