Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x2b276322026-10-31Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 2b27632 · 2026-10-31

Modulecabal-install-3.18.1.0Haskell2010

Distribution.Client.Sandbox.PackageEnvironment

Utilities for working with the package environment file. Patterned after Distribution.Client.Config.

Synopsis

data PackageEnvironment
data PackageEnvironmentType
value classifyPackageEnvironment
value readPackageEnvironmentFile
value showPackageEnvironment
value showPackageEnvironmentWithComments
value loadUserConfig
value userPackageEnvironmentFile

Packagecabal-install-3.18.1.0
Exports8
LanguageHaskell2010
LicenceBSD-3-Clause
SourcePackageEnvironment.hs

datadata PackageEnvironment

Constructors

PackageEnvironment
- pkgEnvSavedConfig :: SavedConfig

Instances4Generic, Semigroup, Monoid, Rep

Generic PackageEnvironmentDefined in cabal-install-3.18.1.0 · Distribution.Client.Sandbox.PackageEnvironment
Semigroup PackageEnvironmentDefined in cabal-install-3.18.1.0 · Distribution.Client.Sandbox.PackageEnvironment
Monoid PackageEnvironmentDefined in cabal-install-3.18.1.0 · Distribution.Client.Sandbox.PackageEnvironment
type Rep PackageEnvironment = D1 ('MetaData "PackageEnvironment" "Distribution.Client.Sandbox.PackageEnvironment" "cabal-install-3.18.1.0-4MgBWnQbRpBByysMMKvgoy" 'False) (C1 ('MetaCons "PackageEnvironment" 'PrefixI 'True) (S1 ('MetaSel ('Just "pkgEnvSavedConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SavedConfig)))Defined in cabal-install-3.18.1.0 · Distribution.Client.Sandbox.PackageEnvironment

datadata PackageEnvironmentType

Type of the current package environment.

Constructors

UserPackageEnvironment
'./cabal.config'
AmbientPackageEnvironment
'~.configcabal/config'

valueclassifyPackageEnvironment :: FilePath -> IO PackageEnvironmentType

Is there a cabal.config in this directory?

valuereadPackageEnvironmentFile

:: ConstraintSource
-> PackageEnvironment
-> FilePath
-> IO (Maybe (ParseResult PackageEnvironment))

Read the package environment file.

valueshowPackageEnvironment :: PackageEnvironment -> String

Pretty-print the package environment.

valueshowPackageEnvironmentWithComments

:: Maybe PackageEnvironment
-> PackageEnvironment
-> String

Pretty-print the package environment with default values for empty fields commented out (just like the default Cabal config file).

valueloadUserConfig :: Verbosity -> FilePath -> Maybe FilePath -> IO SavedConfig

Same as userPackageEnvironmentFile, but returns a SavedConfig.

valueuserPackageEnvironmentFile :: FilePath

Optional package environment file that can be used to customize the default settings. Created by the user.