Skip to content

Commit

Permalink
Move up cabal.release.project for initial build
Browse files Browse the repository at this point in the history
- Put the --project-file option after as suggested by the command help
- Usage: cabal build [TARGETS] [FLAGS]
  • Loading branch information
philderbeast committed May 15, 2024
1 parent 24e1c79 commit 9d2213a
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ published on Hackage, it is sufficient to run:
$ cabal build cabal
```

If for this initial build, you have trouble building the testsuite, then the way
around this is to explicitly use the `cabal.release.project`. This avoids
implicitly picking up the default `cabal.project` that includes the testsuite.

```
$ cabal build cabal --project-file=cabal.release.project
```

For developing, we recommend using the locally built version of `cabal`, the
executable, if only because one of the released versions available may be
lacking a fix.
Expand All @@ -26,13 +34,6 @@ its own arguments, as shown here for `build --help`;
$ cabal run cabal -- build --help
```

If not, you aren't able to build the testsuite, so you need to disable the
default `cabal.project` that implies configuring the testsuite, e.g., with:

```
cabal build --project-file=cabal.release.project cabal
```

> **Note**
> If you're using Nix, you might find it convenient to work within a shell that has all the `Cabal` development dependencies:
> ```
Expand Down

0 comments on commit 9d2213a

Please sign in to comment.