Modulecabal-install-3.18.1.0Haskell2010

Distribution.Client.DistDirLayout

The layout of the ./dist/ directory where cabal keeps all of its state and build artifacts.

6 types
5 values

Packagecabal-install-3.18.1.0
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceDistDirLayout.hs

DistDirLayout

4 declarations

datadata DistDirLayout

The layout of the project state directory. Traditionally this has been called the dist directory.

Constructors

DistDirLayout
- distProjectRootDirectory :: FilePath
  The root directory of the project. Many other files are relative to this location (e.g. the cabal.project file).
- distProjectFile :: ProjectFileKey -> FilePath
  Files that are project parsing roots, the main cabal.project file and its related freeze file and local file.
- distDirectory :: FilePath
  The "dist" directory, which is the root of where cabal keeps all its state including the build artifacts from each package we build.
- distBuildDirectory :: DistDirParams -> FilePath
  The directory under dist where we keep the build artifacts for a package we're building from a local directory.
  This uses a UnitId not just a PackageName because technically we can have multiple instances of the same package in a solution (e.g. setup deps).
- distBuildRootDirectory :: FilePath
- distDownloadSrcDirectory :: FilePath
  The directory under dist where we download tarballs and source control repos to.
- distUnpackedSrcDirectory :: PackageId -> FilePath
  The directory under dist where we put the unpacked sources of packages, in those cases where it makes sense to keep the build artifacts to reduce rebuild times.
- distUnpackedSrcRootDirectory :: FilePath
- distProjectCacheFile :: String -> FilePath
  The location for project-wide cache files (e.g. state used in incremental rebuilds).
- distProjectCacheDirectory :: FilePath
- distPackageCacheFile :: DistDirParams -> String -> FilePath
  The location for package-specific cache files (e.g. state used in incremental rebuilds).
- distPackageCacheDirectory :: DistDirParams -> FilePath
- distSdistFile :: PackageId -> FilePath
  The location that sdists are placed by default.
- distSdistDirectory :: FilePath
- distTempDirectory :: FilePath
- distBinDirectory :: FilePath
- distPackageDB :: CompilerId -> PackageDBCWD
- distHaddockOutputDir :: Maybe FilePath
  Is needed when `--haddock-output-dir` flag is used.

datadata DistDirParams

Information which can be used to construct the path to the build directory of a build. This is LESS fine-grained than what goes into the hashed InstalledPackageId, and for good reason: we don't want this path to change if the user, say, adds a dependency to their project.

Constructors

DistDirParams
- distParamUnitId :: UnitId
- distParamPackageId :: PackageId
- distParamComponentId :: ComponentId
- distParamComponentName :: Maybe ComponentName
- distParamCompilerId :: CompilerId
- distParamPlatform :: Platform
- distParamOptimization :: OptimisationLevel

datadata ProjectFileKey

The principal project file is read and parsed. Its file name was either provided with the --project-file option, or it had the default name of cabal.project.

Related ``.local`` and ``.freeze`` files are read and parsed separately.

This key datatype distinguishes between the different project files, so that we can give better error messages, such as encountering an unexpected extension to the principal project file or when a ``.local`` or ``.freeze`` is itself passed as the principal project file or when either are explicitly imported. They should only ever be implicitly imported.

ProjectFileKeyMain ProjectFileKeyLocal ProjectFileKeyFreeze

Instances3Eq, Ord, Show

Eq ProjectFileKeyDefined in cabal-install-3.18.1.0 · Distribution.Client.DistDirLayout
Ord ProjectFileKeyDefined in cabal-install-3.18.1.0 · Distribution.Client.DistDirLayout
Show ProjectFileKeyDefined in cabal-install-3.18.1.0 · Distribution.Client.DistDirLayout

valuedefaultDistDirLayout

:: ProjectRoot
the project root
-> Maybe FilePath
the dist directory (relative to package root)
-> Maybe FilePath
the documentation directory
-> DistDirLayout

Make the default DistDirLayout based on the project root dir and optional overrides for the location of the dist directory, the cabal.project file and the documentation directory.

ProjectRoot

2 declarations

datadata ProjectRoot

Information about the root directory of the project.

It can either be an implicit project root in the current dir if no cabal.project file is found, or an explicit root if either the file is found or the project root directory was specified.

Constructors

ProjectRootImplicit FilePath
An implicit project root. It contains the absolute project root dir.
ProjectRootExplicit FilePath FilePath
An explicit project root. It contains the absolute project root dir and the relative cabal.project file (or explicit override)
ProjectRootExplicitAbsolute FilePath FilePath
An explicit, absolute project root dir and an explicit, absolute cabal.project file.

Instances2Eq, Show

Eq ProjectRootDefined in cabal-install-3.18.1.0 · Distribution.Client.DistDirLayout
Show ProjectRootDefined in cabal-install-3.18.1.0 · Distribution.Client.DistDirLayout