Documentation

Fields

• globalVersion :: Flag Bool
   
• globalNumericVersion :: Flag Bool
   

Fields

• configArgs :: [String]
   
• 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.

• 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 :: [FilePath]

  path to search for extra libraries

• configExtraLibDirsStatic :: [FilePath]

  path to search for extra libraries when linking fully static executables

• configExtraFrameworkDirs :: [FilePath]

  path to search for extra frameworks (OS X only)

• configExtraIncludeDirs :: [FilePath]

  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

• configDistPref :: Flag FilePath

  "dist" prefix

• configCabalFilePath :: Flag FilePath

  Cabal file to use

• configVerbosity :: Flag Verbosity

  verbosity level

• 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 :: [GivenComponent]

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

Fields

• copyDest :: Flag CopyDest
   
• copyDistPref :: Flag FilePath
   
• copyVerbosity :: Flag Verbosity
   
• copyArgs :: [String]
   
• copyCabalFilePath :: Flag FilePath
   

Fields

• installPackageDB :: Flag PackageDB
   
• installDest :: Flag CopyDest
   
• installDistPref :: Flag FilePath
   
• installUseWrapper :: Flag Bool
   
• installInPlace :: Flag Bool
   
• installVerbosity :: Flag Verbosity
   
• installCabalFilePath :: Flag FilePath
   

Fields

• haddockProgramPaths :: [(String, FilePath)]
   
• haddockProgramArgs :: [(String, [String])]
   
• haddockHoogle :: Flag Bool
   
• haddockHtml :: Flag Bool
   
• haddockHtmlLocation :: Flag String
   
• haddockForHackage :: Flag HaddockTarget
   
• haddockExecutables :: Flag Bool
   
• haddockTestSuites :: Flag Bool
   
• haddockBenchmarks :: Flag Bool
   
• haddockForeignLibs :: Flag Bool
   
• haddockInternal :: Flag Bool
   
• haddockCss :: Flag FilePath
   
• haddockLinkedSource :: Flag Bool
   
• haddockQuickJump :: Flag Bool
   
• haddockHscolourCss :: Flag FilePath
   
• haddockContents :: Flag PathTemplate
   
• haddockIndex :: Flag PathTemplate
   
• haddockDistPref :: Flag FilePath
   
• haddockKeepTempFiles :: Flag Bool
   
• haddockVerbosity :: Flag Verbosity
   
• haddockCabalFilePath :: Flag FilePath
   
• haddockBaseUrl :: Flag String
   
• haddockLib :: Flag String
   
• haddockOutputDir :: Flag FilePath
   
• haddockArgs :: [String]
   

Fields

• haddockProjectHackage :: Flag Bool

  a shortcut option which builds documentation linked to hackage. It implies: * `--html-location='https://hackage.haskell.org/package/$prg-$version/docs' * `--quickjump` * `--gen-index` * `--gen-contents` * `--hyperlinked-source`

• haddockProjectDir :: Flag String

  output directory of combined haddocks, the default is './haddocks'

• haddockProjectPrologue :: Flag String
   
• haddockProjectInterfaces :: Flag [(FilePath, Maybe FilePath, Maybe FilePath, Visibility)]

  haddocksInterfaces is inferred by the haddocksAction; currently not exposed to the user.

• haddockProjectProgramPaths :: [(String, FilePath)]
   
• haddockProjectProgramArgs :: [(String, [String])]
   
• haddockProjectHoogle :: Flag Bool
   
• haddockProjectHtmlLocation :: Flag String
   
• haddockProjectExecutables :: Flag Bool
   
• haddockProjectTestSuites :: Flag Bool
   
• haddockProjectBenchmarks :: Flag Bool
   
• haddockProjectForeignLibs :: Flag Bool
   
• haddockProjectInternal :: Flag Bool
   
• haddockProjectCss :: Flag FilePath
   
• haddockProjectHscolourCss :: Flag FilePath
   
• haddockProjectKeepTempFiles :: Flag Bool
   
• haddockProjectVerbosity :: Flag Verbosity
   
• haddockProjectLib :: Flag String
   
• haddockProjectOutputDir :: Flag FilePath
   

Fields

• hscolourCSS :: Flag FilePath
   
• hscolourExecutables :: Flag Bool
   
• hscolourTestSuites :: Flag Bool
   
• hscolourBenchmarks :: Flag Bool
   
• hscolourForeignLibs :: Flag Bool
   
• hscolourDistPref :: Flag FilePath
   
• hscolourVerbosity :: Flag Verbosity
   
• hscolourCabalFilePath :: Flag FilePath
   

Fields

• buildProgramPaths :: [(String, FilePath)]
   
• buildProgramArgs :: [(String, [String])]
   
• buildDistPref :: Flag FilePath
   
• buildVerbosity :: Flag Verbosity
   
• buildNumJobs :: Flag (Maybe Int)
   
• buildUseSemaphore :: Flag String
   
• buildArgs :: [String]
   
• buildCabalFilePath :: Flag FilePath
   

Fields

• replProgramPaths :: [(String, FilePath)]
   
• replProgramArgs :: [(String, [String])]
   
• replDistPref :: Flag FilePath
   
• replVerbosity :: Flag Verbosity
   
• replReload :: Flag Bool
   
• replReplOptions :: ReplOptions