From d8df6fb2b0c69c1b227303de97ffe525c026ba60 Mon Sep 17 00:00:00 2001 From: Vladislav Zavialov Date: Sun, 24 Jan 2021 18:33:33 +0300 Subject: [PATCH 1/2] Update cabal.project and README build instructions --- README.md | 24 +++++------------------- cabal.project | 9 ++++++++- 2 files changed, 13 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e9ff09ca18..4857920609 100644 --- a/README.md +++ b/README.md @@ -41,11 +41,13 @@ Note: before building `haddock`, you need to build the subprojects `haddock-library` and `haddock-api`, in this order! The `cabal v2-build` takes care of this automatically. -#### Using [`cabal v2-build`][cabal v2] +#### Using `cabal` + +Requires cabal `>= 3.4` and GHC `== 9.0`: ```bash -cabal v2-build -w ghc-8.10.1 -cabal v2-test -w ghc-8.10.1 all +cabal build all --enable-tests --enable-benchmarks +cabal test all ``` #### Using `stack` @@ -57,22 +59,6 @@ export HADDOCK_PATH="$(stack exec which haddock)" stack test ``` -#### Using Cabal sandboxes (deprecated) - -```bash -cabal sandbox init -cabal sandbox add-source haddock-library -cabal sandbox add-source haddock-api -cabal sandbox add-source haddock-test -# adjust -j to the number of cores you want to use -cabal install -j4 --dependencies-only --enable-tests -cabal configure --enable-tests -cabal build -j4 -# run the test suite -export HADDOCK_PATH="dist/build/haddock/haddock" -cabal test -``` - ### Git Branches If you're a GHC developer and want to update Haddock to work with your changes, diff --git a/cabal.project b/cabal.project index 7330a775e9..2525070aa8 100644 --- a/cabal.project +++ b/cabal.project @@ -3,5 +3,12 @@ packages: ./ ./haddock-library ./haddock-test +with-compiler: ghc-9.0 + +allow-newer: + ghc-paths:Cabal, + *:base, + *:ghc-prim + -- Pinning the index-state helps to make reasonably CI deterministic -index-state: 2020-12-08T20:13:44Z +index-state: 2021-01-24T12:09:34Z From 6180ab6f861c4b58688b69dcf29e8a1e5bfa8a0b Mon Sep 17 00:00:00 2001 From: Vladislav Zavialov Date: Sun, 24 Jan 2021 18:47:40 +0300 Subject: [PATCH 2/2] README: there are no benchmarks --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4857920609..d19113c944 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ The `cabal v2-build` takes care of this automatically. Requires cabal `>= 3.4` and GHC `== 9.0`: ```bash -cabal build all --enable-tests --enable-benchmarks +cabal build all --enable-tests cabal test all ```