HORIZON HASKELLDocslts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulecabal-install-3.12.1.0Haskell2010

Distribution.Client.Config

Utilities for handling saved state such as known packages, known servers and downloaded packages.

  • 1 type
  • 28 values
datadata SavedConfig
#

Constructors

Instances4Generic, Semigroup, Monoid, Rep
valueloadConfig :: Verbosity -> Flag FilePath -> IO SavedConfig
#

Loads the main configuration, and applies additional defaults to give the effective configuration. To loads just what is actually in the config file, use loadRawConfig.

valuegetConfigFilePath :: Flag FilePath -> IO FilePath
#

Returns the config file path, without checking that the file exists. The order of precedence is: input flag, CABAL_CONFIG, default location.

valuebaseSavedConfig :: IO SavedConfig
#

These are the absolute basic defaults. The fields that must be initialised. When we load the config from the file we layer the loaded values over these ones, so any missing fields in the file take their values from here.

valuecommentSavedConfig :: IO SavedConfig
#

These are the default values that get used in Cabal if a no value is given. We use these here to include in comments when we write out the initial config file so that the user can see what default value they are overriding.

valueinitialSavedConfig :: IO SavedConfig
#

This is the initial configuration that we write out to the config file if the file does not exist (or the config we use if the file cannot be read for some other reason). When the config gets loaded it gets layered on top of baseSavedConfig so we do not need to include it into the initial values we save into the config file.