Skip to content

Pass CABAL_BUILDDIR to cabal as --builddir #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harendra-kumar merged 1 commit into from
Oct 23, 2026
Merged

Pass CABAL_BUILDDIR to cabal as --builddir #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
* Add `HADDOCK_OPTIONS` option.
* Add `CABAL_INDEX_TTL` option - do not attempt cabal update until it is
stale by this many hours, saves some build time.
* Pass `CABAL_BUILDDIR` to cabal as `--builddir`; cabal v2 commands
ignore the environment variable.
* Windows: Support installing ghc using ghcup.
* Windows: Allow `TEMP` and `TMP` on the command line, so that programs
use the system temporary directory instead of the Windows directory.
Expand Down
15 changes: 13 additions & 2 deletions packcheck.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,7 @@ show_help() {
# XXX this applies to both stack and cabal builds
help_envvar CABAL_REINIT_CONFIG "[y] DESTRUCTIVE! Remove old config to avoid incompatibility issues"
help_envvar CABAL_PROJECT "Alternative cabal project file, path relative to project root"
help_envvar CABAL_BUILDDIR "Absolute path of the cabal build directory, default is dist-newstyle"
help_envvar CABAL_BUILD_OPTIONS "ADDITIONAL cabal build options to append to defaults"
help_envvar CABAL_BUILD_TARGETS "cabal build targets, default is 'all'"
help_envvar CABAL_HADDOCK_TARGETS "cabal haddock targets, default is '.'"
Expand Down Expand Up @@ -1570,6 +1571,11 @@ find_in_parents () {

ensure_cabal_project() {
CABALCMD=$CABAL_BINARY_NAME
# cabal v2 commands do not read CABAL_BUILDDIR from the environment
if test -n "$CABAL_BUILDDIR"
then
CABALCMD="$CABALCMD --builddir=$CABAL_BUILDDIR"
fi

if test -n "$CABAL_PROJECT"
then
Expand Down Expand Up @@ -1858,7 +1864,7 @@ create_and_unpack_pkg_dist() {
# have to go through the whole process once and then again after
# unpacking the sdist and to build it.
SDIST_CMD="$CABALCMD v2-sdist $opts"
SDIST_DIR=dist-newstyle/sdist
SDIST_DIR=${CABAL_BUILDDIR:-dist-newstyle}/sdist
fi

# stack commands return path in windows format
Expand Down Expand Up @@ -2429,8 +2435,13 @@ run_docspec() {

# XXX docspec does not seem to honor --with-compiler though it lists that
# as a flag. It uses "ghc" in PATH.
local builddir_opt=
if test -n "$CABAL_BUILDDIR"
then
builddir_opt="--builddir=$CABAL_BUILDDIR"
fi
run_verbose_errexit $SDIST_CABALCMD exec cabal-docspec -- $DOCSPEC_OPTIONS \
--with-compiler "$COMPILER_EXE_PATH"
$builddir_opt --with-compiler "$COMPILER_EXE_PATH"
fi
}

Expand Down
Loading