Documentation

Fields

• globalVersion :: Flag Bool
   
• globalNumericVersion :: Flag Bool
   
• globalConfigFile :: Flag FilePath
   
• globalConstraintsFile :: Flag FilePath
   
• globalRemoteRepos :: NubList RemoteRepo

  Available Hackage servers.

• globalCacheDir :: Flag FilePath
   
• globalLocalNoIndexRepos :: NubList LocalRepo
   
• globalActiveRepos :: Flag ActiveRepos
   
• globalLogsDir :: Flag FilePath
   
• globalIgnoreExpiry :: Flag Bool

  Ignore security expiry dates

• globalHttpTransport :: Flag String
   
• globalNix :: Flag Bool

  Integrate with Nix

• globalStoreDir :: Flag FilePath
   
• globalProgPathExtra :: NubList FilePath

  Extra program path used for packagedb lookups in a global context (i.e. for http transports)

Fields

• repoContextRepos :: [Repo]

  All user-specified repositories

• repoContextGetTransport :: IO HttpTransport

  Get the HTTP transport

  The transport will be initialized on the first call to this function.

  NOTE: It is important that we don't eagerly initialize the transport. Initializing the transport is not free, and especially in contexts where we don't know a priori whether or not we need the transport (for instance when using cabal in "nix mode") incurring the overhead of transport initialization on _every_ invocation (eg cabal build) is undesirable.

• repoContextWithSecureRepo :: forall a. Repo -> (forall (down :: Type -> Type). Repository down -> IO a) -> IO a

  Get the (initialized) secure repo

  (the Repo type itself is stateless and must remain so, because it must be serializable)

• repoContextIgnoreExpiry :: Bool

  Should we ignore expiry times (when checking security)?

Fields

• setupVerbosity :: !(Flag Verbosity)

  Verbosity

• setupWorkingDir :: !(Flag (SymbolicPath CWD ('Dir Pkg)))

  Working directory (optional)

• setupDistPref :: !(Flag (SymbolicPath Pkg ('Dir Dist)))

  Build directory

• setupCabalFilePath :: !(Flag (SymbolicPath Pkg 'File))

  Which Cabal file to use (optional)

• setupTargets :: [String]

  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

• setupKeepTempFiles :: Flag Bool

  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.

Fields

• configCommonFlags :: !CommonSetupFlags
   
• configPrograms_ :: Option' (Last' ProgramDb)

  All programs that cabal may run

• configProgramPaths :: [(String, FilePath)]

  user specified programs paths

• configProgramArgs :: [(String, [String])]

  user specified programs args

• configProgramPathExtra :: NubList FilePath

  Extend the $PATH

• configHcFlavor :: Flag CompilerFlavor

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

• configHcPath :: Flag FilePath

  given compiler location

• configHcPkg :: Flag FilePath

  given hc-pkg location

• configVanillaLib :: Flag Bool

  Enable vanilla library

• configProfLib :: Flag Bool

  Enable profiling in the library

• configSharedLib :: Flag Bool

  Build shared library

• configStaticLib :: Flag Bool

  Build static library

• configDynExe :: Flag Bool

  Enable dynamic linking of the executables.

• configFullyStaticExe :: Flag Bool

  Enable fully static linking of the executables.

• configProfExe :: Flag Bool

  Enable profiling in the executables.

• configProf :: Flag Bool

  Enable profiling in the library and executables.

• configProfShared :: Flag Bool

  Enable shared profiling objects

• configProfDetail :: Flag ProfDetailLevel

  Profiling detail level in the library and executables.

• configProfLibDetail :: Flag ProfDetailLevel

  Profiling detail level in the library

• configConfigureArgs :: [String]

  Extra arguments to configure

• configOptimization :: Flag OptimisationLevel

  Enable optimization.

• configProgPrefix :: Flag PathTemplate

  Installed executable prefix.

• configProgSuffix :: Flag PathTemplate

  Installed executable suffix.

• configInstallDirs :: InstallDirs (Flag PathTemplate)

  Installation paths

• configScratchDir :: Flag FilePath
   
• configExtraLibDirs :: [SymbolicPath Pkg ('Dir Lib)]

  path to search for extra libraries

• configExtraLibDirsStatic :: [SymbolicPath Pkg ('Dir Lib)]

  path to search for extra libraries when linking fully static executables

• configExtraFrameworkDirs :: [SymbolicPath Pkg ('Dir Framework)]

  path to search for extra frameworks (OS X only)

• configExtraIncludeDirs :: [SymbolicPath Pkg ('Dir Include)]

  path to search for header files

• configIPID :: Flag String

  explicit IPID to be used

• configCID :: Flag ComponentId

  explicit CID to be used

• configDeterministic :: Flag Bool

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

• configUserInstall :: Flag Bool

  The --user/--global flag

• configPackageDBs :: [Maybe PackageDB]

  Which package DBs to use

• configGHCiLib :: Flag Bool

  Enable compiling library for GHCi

• configSplitSections :: Flag Bool

  Enable -split-sections with GHC

• configSplitObjs :: Flag Bool

  Enable -split-objs with GHC

• configStripExes :: Flag Bool

  Enable executable stripping

• configStripLibs :: Flag Bool

  Enable library stripping

• configConstraints :: [PackageVersionConstraint]

  Additional constraints for dependencies.

• configDependencies :: [GivenComponent]

  The packages depended on which already exist

• configPromisedDependencies :: [PromisedComponent]

  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.

• configInstantiateWith :: [(ModuleName, Module)]

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

• configConfigurationsFlags :: FlagAssignment
   
• configTests :: Flag Bool

  Enable test suite compilation

• configBenchmarks :: Flag Bool

  Enable benchmark compilation

• configCoverage :: Flag Bool

  Enable program coverage

• configLibCoverage :: Flag Bool

  Enable program coverage (deprecated)

• configExactConfiguration :: Flag Bool

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

• configFlagError :: Flag String

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

• configRelocatable :: Flag Bool

  Enable relocatable package built

• configDebugInfo :: Flag DebugInfoLevel

  Emit debug info.

• configDumpBuildInfo :: Flag DumpBuildInfo

  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.

• configUseResponseFiles :: Flag Bool

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

• configAllowDependingOnPrivateLibs :: Flag Bool

  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.

• configCoverageFor :: Flag [UnitId]

  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).

• configIgnoreBuildTools :: Flag Bool

  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.

Fields

• configCabalVersion :: Flag Version
   
• configAppend :: Flag Bool
   
• configBackup :: Flag Bool
   
• configExConstraints :: [(UserConstraint, ConstraintSource)]
   
• configPreferences :: [PackageVersionConstraint]
   
• configSolver :: Flag PreSolver
   
• configAllowNewer :: Maybe AllowNewer
   
• configAllowOlder :: Maybe AllowOlder
   
• configWriteGhcEnvironmentFilesPolicy :: Flag WriteGhcEnvironmentFilesPolicy
   

Fields

• buildCommonFlags :: !CommonSetupFlags
   
• buildProgramPaths :: [(String, FilePath)]
   
• buildProgramArgs :: [(String, [String])]
   
• buildNumJobs :: Flag (Maybe Int)
   
• buildUseSemaphore :: Flag String
   

Fields

• installDocumentation :: Flag Bool
   
• installHaddockIndex :: Flag PathTemplate
   
• installDest :: Flag CopyDest
   
• installDryRun :: Flag Bool
   
• installOnlyDownload :: Flag Bool
   
• installMaxBackjumps :: Flag Int
   
• installReorderGoals :: Flag ReorderGoals
   
• installCountConflicts :: Flag CountConflicts
   
• installFineGrainedConflicts :: Flag FineGrainedConflicts
   
• installMinimizeConflictSet :: Flag MinimizeConflictSet
   
• installIndependentGoals :: Flag IndependentGoals
   
• installPreferOldest :: Flag PreferOldest
   
• installShadowPkgs :: Flag ShadowPkgs
   
• installStrongFlags :: Flag StrongFlags
   
• installAllowBootLibInstalls :: Flag AllowBootLibInstalls
   
• installOnlyConstrained :: Flag OnlyConstrained
   
• installReinstall :: Flag Bool
   
• installAvoidReinstalls :: Flag AvoidReinstalls
   
• installOverrideReinstall :: Flag Bool
   
• installUpgradeDeps :: Flag Bool
   
• installOnly :: Flag Bool
   
• installOnlyDeps :: Flag Bool
   
• installIndexState :: Flag TotalIndexState
   
• installRootCmd :: Flag String
   
• installSummaryFile :: NubList PathTemplate
   
• installLogFile :: Flag PathTemplate
   
• installBuildReports :: Flag ReportLevel
   
• installReportPlanningFailure :: Flag Bool
   
• installSymlinkBinDir :: Flag FilePath
   
• installPerComponent :: Flag Bool
   
• installNumJobs :: Flag (Maybe Int)
   
• installUseSemaphore :: Flag Bool
   
• installKeepGoing :: Flag Bool
   
• installRunTests :: Flag Bool
   
• installOfflineMode :: Flag Bool
   

Fields

• listInstalled :: Flag Bool
   
• listSimpleOutput :: Flag Bool
   
• listCaseInsensitive :: Flag Bool
   
• listVerbosity :: Flag Verbosity
   
• listPackageDBs :: [Maybe PackageDB]
   
• listHcPath :: Flag FilePath
   

Fields

• updateVerbosity :: Flag Verbosity
   
• updateIndexState :: Flag TotalIndexState
   

Fields

• infoVerbosity :: Flag Verbosity
   
• infoPackageDBs :: [Maybe PackageDB]
   

Fields

• fetchDeps :: Flag Bool
   
• fetchDryRun :: Flag Bool
   
• fetchSolver :: Flag PreSolver
   
• fetchMaxBackjumps :: Flag Int
   
• fetchReorderGoals :: Flag ReorderGoals
   
• fetchCountConflicts :: Flag CountConflicts
   
• fetchFineGrainedConflicts :: Flag FineGrainedConflicts
   
• fetchMinimizeConflictSet :: Flag MinimizeConflictSet
   
• fetchIndependentGoals :: Flag IndependentGoals
   
• fetchPreferOldest :: Flag PreferOldest
   
• fetchShadowPkgs :: Flag ShadowPkgs
   
• fetchStrongFlags :: Flag StrongFlags
   
• fetchAllowBootLibInstalls :: Flag AllowBootLibInstalls
   
• fetchOnlyConstrained :: Flag OnlyConstrained
   
• fetchTests :: Flag Bool
   
• fetchBenchmarks :: Flag Bool
   
• fetchVerbosity :: Flag Verbosity
   

Fields

• freezeDryRun :: Flag Bool
   
• freezeTests :: Flag Bool
   
• freezeBenchmarks :: Flag Bool
   
• freezeSolver :: Flag PreSolver
   
• freezeMaxBackjumps :: Flag Int
   
• freezeReorderGoals :: Flag ReorderGoals
   
• freezeCountConflicts :: Flag CountConflicts
   
• freezeFineGrainedConflicts :: Flag FineGrainedConflicts
   
• freezeMinimizeConflictSet :: Flag MinimizeConflictSet
   
• freezeIndependentGoals :: Flag IndependentGoals
   
• freezePreferOldest :: Flag PreferOldest
   
• freezeShadowPkgs :: Flag ShadowPkgs
   
• freezeStrongFlags :: Flag StrongFlags
   
• freezeAllowBootLibInstalls :: Flag AllowBootLibInstalls
   
• freezeOnlyConstrained :: Flag OnlyConstrained
   
• freezeVerbosity :: Flag Verbosity
   

Fields

• getDestDir :: Flag FilePath
   
• getOnlyPkgDescr :: Flag Bool
   
• getPristine :: Flag Bool
   
• getIndexState :: Flag TotalIndexState
   
• getActiveRepos :: Flag ActiveRepos
   
• getSourceRepository :: Flag (Maybe RepoKind)
   
• getVerbosity :: Flag Verbosity