From 9d2213aa6ca0d723be72ebcd6d08937ecf72fa65 Mon Sep 17 00:00:00 2001 From: Phil de Joux Date: Wed, 15 May 2024 07:20:11 -0400 Subject: [PATCH] Move up cabal.release.project for initial build - Put the --project-file option after as suggested by the command help - Usage: cabal build [TARGETS] [FLAGS] --- CONTRIBUTING.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e19cbd7d6a..fffe7cd0cd9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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: > ```