Skip to content
This repository was archived by the owner on Aug 3, 2024. It is now read-only.

[see 1306 instead] Update cabal.project and README build instructions #1305

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
cabal test all
```

#### Using `stack`
Expand All @@ -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,
Expand Down
9 changes: 8 additions & 1 deletion cabal.project
Original file line number Diff line number Diff line change
Expand Up @@ -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