Cabal-1.2.0: A framework for packaging Haskell software Contents Index

Distribution.Simple.LocalBuildInfo Portability portable Stability alpha Maintainer Isaac Jones <ijones@syntaxpolice.org>

Contents Installation directories Deprecated install dir functions Build directories

Description

Definition of the LocalBuildInfo data type. This is basically the information that is gathered by the end of the configuration step which could include package information from ghc-pkg, flags the user passed to configure, and the location of tools in the PATH.

Synopsis

data LocalBuildInfo = LocalBuildInfo { installDirTemplates :: InstallDirTemplates compiler :: Compiler buildDir :: FilePath scratchDir :: FilePath packageDeps :: [PackageIdentifier] localPkgDescr :: PackageDescription withPrograms :: ProgramConfiguration withPackageDB :: PackageDB withVanillaLib :: Bool withProfLib :: Bool withSharedLib :: Bool withProfExe :: Bool withOptimization :: Bool withGHCiLib :: Bool splitObjs :: Bool } module Distribution.Simple.InstallDirs absoluteInstallDirs :: PackageDescription -> LocalBuildInfo -> CopyDest -> InstallDirs FilePath prefixRelativeInstallDirs :: PackageDescription -> LocalBuildInfo -> InstallDirs (Maybe FilePath) mkLibDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath mkBinDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath mkLibexecDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath mkDataDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath distPref :: FilePath srcPref :: FilePath hscolourPref :: PackageDescription -> FilePath haddockPref :: PackageDescription -> FilePath autogenModulesDir :: LocalBuildInfo -> String

Documentation

data LocalBuildInfo

Data cached after configuration step. See also ConfigFlags. Constructors LocalBuildInfo installDirTemplates :: InstallDirTemplates The installation directories for the various differnt kinds of files compiler :: Compiler The compiler we're building with buildDir :: FilePath Where to build the package. scratchDir :: FilePath Where to put the result of the Hugs build. packageDeps :: [PackageIdentifier] Which packages we depend on, exactly. The PackageDescription specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler. localPkgDescr :: PackageDescription The resolved package description, that does not contain any conditionals. withPrograms :: ProgramConfiguration Location and args for all programs withPackageDB :: PackageDB What package database to use, global/user withVanillaLib :: Bool Whether to build normal libs. withProfLib :: Bool Whether to build profiling versions of libs. withSharedLib :: Bool Whether to build shared versions of libs. withProfExe :: Bool Whether to build executables for profiling. withOptimization :: Bool Whether to build with optimization (if available). withGHCiLib :: Bool Whether to build libs suitable for use with GHCi. splitObjs :: Bool Use -split-objs with GHC, if available Instances Read LocalBuildInfo Show LocalBuildInfo

Installation directories

module Distribution.Simple.InstallDirs

absoluteInstallDirs :: PackageDescription -> LocalBuildInfo -> CopyDest -> InstallDirs FilePath

See absoluteInstallDirs

prefixRelativeInstallDirs :: PackageDescription -> LocalBuildInfo -> InstallDirs (Maybe FilePath)

See prefixRelativeInstallDirs

Deprecated install dir functions

mkLibDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath

mkBinDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath

mkLibexecDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath

mkDataDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath

Build directories

distPref :: FilePath

srcPref :: FilePath

hscolourPref :: PackageDescription -> FilePath

haddockPref :: PackageDescription -> FilePath

autogenModulesDir :: LocalBuildInfo -> String

The directory in which we put auto-generated modules

Produced by Haddock version 0.8