[Git][ghc/ghc][wip/jacco/haddock/running-tests] Document how to run haddocks tests (#24976)

[Jacco Krijnen (@jacco)]

Jacco Krijnen pushed to branch wip/jacco/haddock/running-tests at Glasgow Haskell Compiler / GHC


Commits:
80bf8260 by Jacco Krijnen at 2024-06-11T18:58:08+02:00
Document how to run haddocks tests (#24976)

Also remove ghc 9.7 requirement

- - - - -


2 changed files:

- utils/haddock/CONTRIBUTING.md
- utils/haddock/cabal.project


Changes:

=====================================
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:


=====================================
utils/haddock/cabal.project
=====================================
@@ -1,5 +1,3 @@
-with-compiler: ghc-9.7
-
 packages: ./
           ./haddock-api
           ./haddock-library



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/80bf8260b3928a63a31a5485c65be768c6258657

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/80bf8260b3928a63a31a5485c65be768c6258657
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20240611/951e5135/attachment-0001.html>