Safe Haskell | None |
---|---|
Language | Haskell2010 |
Constants used throughout the project.
Synopsis
- buildPlanDir :: Path Abs Dir -> Path Abs Dir
- buildPlanCacheDir :: Path Abs Dir -> Path Abs Dir
- haskellFileExts :: [Text]
- haskellPreprocessorExts :: [Text]
- stackDotYaml :: Path Rel File
- stackWorkEnvVar :: String
- stackRootEnvVar :: String
- stackRootOptionName :: String
- deprecatedStackRootOptionName :: String
- inContainerEnvVar :: String
- inNixShellEnvVar :: String
- stackProgNameUpper :: String
- wiredInPackages :: Set PackageName
- ghcjsBootPackages :: Set PackageName
- cabalPackageName :: PackageName
- implicitGlobalProjectDirDeprecated :: Path Abs Dir -> Path Abs Dir
- implicitGlobalProjectDir :: Path Abs Dir -> Path Abs Dir
- defaultUserConfigPathDeprecated :: Path Abs Dir -> Path Abs File
- defaultUserConfigPath :: Path Abs Dir -> Path Abs File
- defaultGlobalConfigPathDeprecated :: Maybe (Path Abs File)
- defaultGlobalConfigPath :: Maybe (Path Abs File)
- platformVariantEnvVar :: String
- compilerOptionsCabalFlag :: WhichCompiler -> String
- ghcColorForceFlag :: String
- minTerminalWidth :: Int
- maxTerminalWidth :: Int
- defaultTerminalWidth :: Int
- osIsWindows :: Bool
- relFileSetupHs :: Path Rel File
- relFileSetupLhs :: Path Rel File
- relFileHpackPackageConfig :: Path Rel File
- relDirGlobalAutogen :: Path Rel Dir
- relDirAutogen :: Path Rel Dir
- relDirLogs :: Path Rel Dir
- relFileCabalMacrosH :: Path Rel File
- relDirBuild :: Path Rel Dir
- relDirBin :: Path Rel Dir
- relDirPantry :: Path Rel Dir
- relDirPrograms :: Path Rel Dir
- relDirUpperPrograms :: Path Rel Dir
- relDirStackProgName :: Path Rel Dir
- relDirStackWork :: Path Rel Dir
- relFileReadmeTxt :: Path Rel File
- relDirScript :: Path Rel Dir
- relFileConfigYaml :: Path Rel File
- relDirSnapshots :: Path Rel Dir
- relDirGlobalHints :: Path Rel Dir
- relFileGlobalHintsYaml :: Path Rel File
- relDirInstall :: Path Rel Dir
- relDirCompilerTools :: Path Rel Dir
- relDirHoogle :: Path Rel Dir
- relFileDatabaseHoo :: Path Rel File
- relDirPkgdb :: Path Rel Dir
- relFileStorage :: Path Rel File
- relDirLoadedSnapshotCache :: Path Rel Dir
- bindirSuffix :: Path Rel Dir
- docDirSuffix :: Path Rel Dir
- relDirHpc :: Path Rel Dir
- relDirLib :: Path Rel Dir
- relDirShare :: Path Rel Dir
- relDirLibexec :: Path Rel Dir
- relDirEtc :: Path Rel Dir
- setupGhciShimCode :: Builder
- relDirSetupExeCache :: Path Rel Dir
- relDirSetupExeSrc :: Path Rel Dir
- relFileConfigure :: Path Rel File
- relDirDist :: Path Rel Dir
- relFileSetupMacrosH :: Path Rel File
- relDirSetup :: Path Rel Dir
- relFileSetupLower :: Path Rel File
- relDirMingw :: Path Rel Dir
- relDirMingw32 :: Path Rel Dir
- relDirMingw64 :: Path Rel Dir
- relDirLocal :: Path Rel Dir
- relDirUsr :: Path Rel Dir
- relDirInclude :: Path Rel Dir
- relFileIndexHtml :: Path Rel File
- relDirAll :: Path Rel Dir
- relFilePackageCache :: Path Rel File
- relFileDockerfile :: Path Rel File
- relDirHaskellStackGhci :: Path Rel Dir
- relFileGhciScript :: Path Rel File
- relDirCombined :: Path Rel Dir
- relFileHpcIndexHtml :: Path Rel File
- relDirCustom :: Path Rel Dir
- relDirPackageConfInplace :: Path Rel Dir
- relDirExtraTixFiles :: Path Rel Dir
- relDirInstalledPackages :: Path Rel Dir
- backupUrlRelPath :: Path Rel File
- relDirDotLocal :: Path Rel Dir
- relDirDotSsh :: Path Rel Dir
- relDirDotStackProgName :: Path Rel Dir
- relDirUnderHome :: Path Rel Dir
- relDirSrc :: Path Rel Dir
- relFileLibtinfoSo5 :: Path Rel File
- relFileLibtinfoSo6 :: Path Rel File
- relFileLibncurseswSo6 :: Path Rel File
- relFileLibgmpSo10 :: Path Rel File
- relFileLibgmpSo3 :: Path Rel File
- relDirNewCabal :: Path Rel Dir
- relFileSetupExe :: Path Rel File
- relFileSetupUpper :: Path Rel File
- relFile7zexe :: Path Rel File
- relFile7zdll :: Path Rel File
- relFileMainHs :: Path Rel File
- relFileStack :: Path Rel File
- relFileStackDotExe :: Path Rel File
- relFileStackDotTmpDotExe :: Path Rel File
- relFileStackDotTmp :: Path Rel File
- ghcShowOptionsOutput :: [String]
- hadrianCmdWindows :: Path Rel File
- hadrianCmdPosix :: Path Rel File
- usrLibDirs :: [Path Abs Dir]
- testGhcEnvRelFile :: Path Rel File
- relFileBuildLock :: Path Rel File
Documentation
Path where binary caches of the build plans are stored.
haskellFileExts :: [Text] Source #
Extensions used for Haskell modules. Excludes preprocessor ones.
haskellPreprocessorExts :: [Text] Source #
Extensions for modules that are preprocessed by common preprocessors.
stackWorkEnvVar :: String Source #
Environment variable used to override the '.stack-work' relative dir.
stackRootEnvVar :: String Source #
Environment variable used to override the '~/.stack' location.
stackRootOptionName :: String Source #
Option name for the global stack root.
deprecatedStackRootOptionName :: String Source #
Deprecated option name for the global stack root.
Deprecated since stack-1.1.0.
TODO: Remove occurences of this variable and use stackRootOptionName
only
after an appropriate deprecation period.
inContainerEnvVar :: String Source #
Environment variable used to indicate stack is running in container.
inNixShellEnvVar :: String Source #
Environment variable used to indicate stack is running in container. although we already have STACK_IN_NIX_EXTRA_ARGS that is set in the same conditions, it can happen that STACK_IN_NIX_EXTRA_ARGS is set to empty.
stackProgNameUpper :: String Source #
Name of the stack
program, uppercased
cabalPackageName :: PackageName Source #
Just to avoid repetition and magic strings.
implicitGlobalProjectDirDeprecated Source #
Deprecated implicit global project directory used when outside of a project.
implicitGlobalProjectDir Source #
Implicit global project directory used when outside of a project.
Normally, getImplicitGlobalProjectDir
should be used instead.
defaultUserConfigPathDeprecated :: Path Abs Dir -> Path Abs File Source #
Deprecated default global config path.
defaultUserConfigPath :: Path Abs Dir -> Path Abs File Source #
Default global config path.
Normally, getDefaultUserConfigPath
should be used instead.
defaultGlobalConfigPathDeprecated :: Maybe (Path Abs File) Source #
Deprecated default global config path.
Note that this will be Nothing
on Windows, which is by design.
defaultGlobalConfigPath :: Maybe (Path Abs File) Source #
Default global config path.
Normally, getDefaultGlobalConfigPath
should be used instead.
Note that this will be Nothing
on Windows, which is by design.
platformVariantEnvVar :: String Source #
Environment variable that stores a variant to append to platform-specific directory names. Used to ensure incompatible binaries aren't shared between Docker builds and host
ghcColorForceFlag :: String Source #
The flag to pass to GHC when we want to force its output to be colorized.
minTerminalWidth :: Int Source #
The minimum allowed terminal width. Used for pretty-printing.
maxTerminalWidth :: Int Source #
The maximum allowed terminal width. Used for pretty-printing.
defaultTerminalWidth :: Int Source #
The default terminal width. Used for pretty-printing when we can't automatically detect it and when the user doesn't supply one.
osIsWindows :: Bool Source #
True if using Windows OS.
hadrianCmdWindows :: Path Rel File Source #
Relative path inside a GHC repo to the Hadrian build batch script
hadrianCmdPosix :: Path Rel File Source #
Relative path inside a GHC repo to the Hadrian build shell script
usrLibDirs :: [Path Abs Dir] Source #
Used in Stack.Setup for detecting libtinfo, see comments at use site