HORIZON HASKELLDocslts/ghc-10.0.xaa25b892026-10-10Search names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917 · lts/ghc-10.0.x · aa25b89 · 2026-10-10

Modulecabal-install-3.18.1.0Haskell2010

Distribution.Client.Setup

  • 20 types
  • 68 values
datadata GlobalFlags
#

Flags that apply at the top level, not to any sub-command.

Constructors

Instances5Show, Generic, Semigroup, Monoid, Rep
datadata RepoContext
#

Access to repositories

Constructors

  • RepoContext
    • 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)?

datadata CommonSetupFlags
#

A datatype that stores common flags for different invocations of a Setup executable, e.g. configure, build, install.

Constructors

Instances9Eq, Read, Show, Generic, Semigroup, Monoid, …
datadata ConfigFlags
#

Flags to configure command.

IMPORTANT: every time a new flag is added, D.C.Setup.filterConfigureFlags should be updated. IMPORTANT: every time a new flag is added, it should be added to the Eq instance

Constructors

Instances10Eq, Read, Show, Generic, Semigroup, Monoid, …
valuefilterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
#

Given some ConfigFlags for the version of Cabal that cabal-install was built with, and a target older Version of Cabal that we want to pass these flags to, convert the flags into a form that will be accepted by the older Setup script. Generally speaking, this just means filtering out flags that the old Cabal library doesn't understand, but in some cases it may also mean "emulating" a feature using some more legacy flags.

datadata ConfigExFlags
#

cabal configure takes some extra flags beyond runghc Setup configure

Constructors

Instances6Eq, Show, Generic, Semigroup, Monoid, Rep
datadata BuildFlags
#

Constructors

Instances9Read, Show, Generic, Semigroup, Monoid, Binary, …
valuefilterBuildFlags :: BuildFlags -> Version -> BuildFlags
#

Given some BuildFlags for the version of Cabal that cabal-install was built with, and a target older Version of Cabal that we want to pass these flags to, convert the flags into a form that will be accepted by the older Setup script. Generally speaking, this just means filtering out flags that the old Cabal library doesn't understand, but in some cases it may also mean "emulating" a feature using some more legacy flags.

valuefilterTestFlags :: TestFlags -> Version -> TestFlags
#

Given some TestFlags for the version of Cabal that cabal-install was built with, and a target older Version of Cabal that we want to pass these flags to, convert the flags into a form that will be accepted by the older Setup script. Generally speaking, this just means filtering out flags that the old Cabal library doesn't understand, but in some cases it may also mean "emulating" a feature using some more legacy flags.

valuefilterReplFlags :: ReplFlags -> Version -> ReplFlags
#

Given some ReplFlags for the version of Cabal that cabal-install was built with, and a target older Version of Cabal that we want to pass these flags to, convert the flags into a form that will be accepted by the older Setup script. Generally speaking, this just means filtering out flags that the old Cabal library doesn't understand, but in some cases it may also mean "emulating" a feature using some more legacy flags.

valuefilterBenchmarkFlags :: BenchmarkFlags -> Version -> BenchmarkFlags
#

Given some BenchmarkFlags for the version of Cabal that cabal-install was built with, and a target older Version of Cabal that we want to pass these flags to, convert the flags into a form that will be accepted by the older Setup script. Generally speaking, this just means filtering out flags that the old Cabal library doesn't understand, but in some cases it may also mean "emulating" a feature using some more legacy flags.

datadata InstallFlags
#

Install takes the same flags as configure along with a few extras.

Constructors

Instances7Eq, Show, Generic, Semigroup, Monoid, Binary, …
valuefilterHaddockFlags :: HaddockFlags -> Version -> HaddockFlags
#

Given some HaddockFlags for the version of Cabal that cabal-install was built with, and a target older Version of Cabal that we want to pass these flags to, convert the flags into a form that will be accepted by the older Setup script. Generally speaking, this just means filtering out flags that the old Cabal library doesn't understand, but in some cases it may also mean "emulating" a feature using some more legacy flags.

datadata ListFlags
#

Constructors

Instances4Generic, Semigroup, Monoid, Rep
datadata UpdateFlags
#

Constructors

Instances3Generic, HasVerbosity, Rep
datadata InfoFlags
#

Constructors

Instances4Generic, Semigroup, Monoid, Rep
datadata FetchFlags
#

Constructors

datadata FreezeFlags
#

Constructors

Instances1HasVerbosity
  • HasVerbosity FreezeFlagsDefined in cabal-install-3.18.1.0 · Distribution.Client.CmdLegacy
datadata GetFlags
#

Constructors

Instances4Generic, Semigroup, Monoid, Rep
datadata UploadFlags
#

Constructors

Instances4Generic, Semigroup, Monoid, Rep
datadata ReportFlags
#

Constructors

Instances4Generic, Semigroup, Monoid, Rep
datadata InitFlags
#

InitFlags is a subset of flags available in the .cabal file that represent options that are relevant to the init command process.

Constructors

Instances6Eq, Show, Generic, Semigroup, Monoid, Rep
datadata ActAsSetupFlags
#

Constructors

Instances4Generic, Semigroup, Monoid, Rep
datadata UserConfigFlags
#

Constructors

Instances4Generic, Semigroup, Monoid, Rep
valuefilterCopyFlags :: CopyFlags -> Version -> CopyFlags
#

Given some CopyFlags for the version of Cabal that cabal-install was built with, and a target older Version of Cabal that we want to pass these flags to, convert the flags into a form that will be accepted by the older Setup script. Generally speaking, this just means filtering out flags that the old Cabal library doesn't understand, but in some cases it may also mean "emulating" a feature using some more legacy flags.

valuefilterRegisterFlags :: RegisterFlags -> Version -> RegisterFlags
#

Given some RegisterFlags for the version of Cabal that cabal-install was built with, and a target older Version of Cabal that we want to pass these flags to, convert the flags into a form that will be accepted by the older Setup script. Generally speaking, this just means filtering out flags that the old Cabal library doesn't understand, but in some cases it may also mean "emulating" a feature using some more legacy flags.