Distribution.Client.Setup

Verbosity

Working directory (optional)

Build directory

Which Cabal file to use (optional)

Which targets is this Setup invocation relative to?

TODO: this one should not be here, it's just that the silly UserHooks stop us from passing extra info in other ways

When this flag is set, temporary files will be kept after building.

Note: Keeping temporary files is important functionality for HLS, which runs cabal repl with a fake GHC to get CLI arguments. It will need the temporary files (including multi unit repl response files) to stay, even after the cabal repl command exits.

All programs that cabal may run

user specified programs paths

user specified programs args

Extend the $PATH

The "flavor" of the compiler, e.g. GHC.

given compiler location

given hc-pkg location

Enable vanilla library

Enable profiling in the library

Build shared library

Build static library

Build bytecode library

Enable dynamic linking of the executables.

Enable fully static linking of the executables.

Enable profiling in the executables.

Enable profiling in the library and executables.

Enable shared profiling objects

Profiling detail level in the library and executables.

Profiling detail level in the library

Extra arguments to configure

Enable optimization.

Installed executable prefix.

Installed executable suffix.

Installation paths

path to search for extra libraries

path to search for extra libraries when linking fully static executables

path to search for extra frameworks (OS X only)

path to search for header files

explicit IPID to be used

explicit CID to be used

be as deterministic as possible (e.g., invariant over GHC, database, etc). Used by the test suite

The --user/--global flag

Which package DBs to use

Enable compiling library for GHCi

Enable -split-sections with GHC

Enable -split-objs with GHC

Enable executable stripping

Enable library stripping

Additional constraints for dependencies.

The packages depended on which already exist

The packages depended on which doesn't yet exist (i.e. promised). Promising dependencies enables us to configure components in parallel, and avoids expensive builds if they are not necessary. For example, in multi-repl mode, we don't want to build dependencies that are loaded into the interactive session, since we have to build them again.

The requested Backpack instantiation. If empty, either this package does not use Backpack, or we just want to typecheck the indefinite package.

Enable test suite compilation

Enable benchmark compilation

Enable program coverage

Enable program coverage (deprecated)

All direct dependencies and flags are provided on the command line by the user via the '--dependency' and '--flags' options.

Halt and show an error message indicating an error in flag assignment

Enable relocatable package built

Emit debug info.

Should we dump available build information on build? Dump build information to disk before attempting to build, tooling can parse these files and use them to compile the source files themselves.

Whether to use response files at all. They're used for such tools as haddock, or ld.

Allow depending on private sublibraries. This is used by external tools (like cabal-install) so they can add multiple-public-libraries compatibility to older ghcs by checking visibility externally.

The list of libraries to be included in the hpc coverage report for testsuites run with --enable-coverage. Notably, this list must exclude indefinite libraries and instantiations because HPC does not support backpack (Nov. 2023).

When this flag is set, all tools declared in `build-tool`s and `build-tool-depends` will be ignored. This allows a Cabal package with build-tool-dependencies to be built even if the tool is not found.