Suppose that you are in a directory containing a single Cabal package which you wish to build (if you haven’t set up a package yet check out developing packages for instructions). You can configure and build it using Nix-style local builds with this command (configuring is not necessary):
$ cabal v2-build
To open a GHCi shell with this package, use this command:
$ cabal v2-repl
To run an executable defined in this package, use this command:
$ cabal v2-run <executable name> [executable args]
5.1.1. Developing multiple packages¶
Many Cabal projects involve multiple packages which need to be built
together. To build multiple Cabal packages, you need to first create a
cabal.project file which declares where all the local package
directories live. For example, in the Cabal repository, there is a root
directory with a folder per package, e.g., the folders
cabal.project file specifies each folder as
part of the project:
packages: Cabal/ cabal-install/
The expectation is that a
cabal.project is checked into your source
control, to be used by all developers of a project. If you need to make
local changes, they can be placed in
should not be checked in.)
Then, to build every component of every package, from the top-level directory, run the command: (using cabal-install-2.0 or greater.)
$ cabal v2-build all
To build a specific package, you can either run
v2-build from the
directory of the package in question:
$ cd cabal-install $ cabal v2-build
or you can pass the name of the package as an argument to
cabal v2-build (this works in any subdirectory of the project):
$ cabal v2-build cabal-install
You can also specify a specific component of the package to build. For
example, to build a test suite named
package-tests, use the command:
$ cabal v2-build package-tests
Targets can be qualified with package names. So to request
package-tests from the
Cabal package, use
Unlike sandboxes, there is no need to setup a sandbox or
projects; just check in
cabal.project to your repository and
v2-build will just work.
5.2.1. How can I profile my library/application?¶
Create or edit your
cabal.project.local, adding the following
cabal v2-build will automatically build all libraries and
executables with profiling. You can fine-tune the profiling settings
for each package using
package p profiling-detail: toplevel-functions
Alternately, you can call
cabal v2-build --enable-profiling to
temporarily build with profiling.
5.3. How it works¶
5.3.1. Local versus external packages¶
One of the primary innovations of Nix-style local builds is the distinction between local packages, which users edit and recompile and must be built per-project, versus external packages, which can be cached across projects. To be more precise:
- A local package is one that is listed explicitly in the
extra-packagesfield of a project. Usually, these refer to packages whose source code lives directly in a folder in your project. But you can list an arbitrary Hackage package in
packagesto force it to be treated as local.
Local packages, as well as the external packages (below) which depend on them, are built inplace, meaning that they are always built specifically for the project and are not installed globally. Inplace packages are not cached and not given unique hashes, which makes them suitable for packages which you want to edit and recompile.
- An external package is any package which is not listed in the
packagesfield. The source code for external packages is usually retrieved from Hackage.
When an external package does not depend on an inplace package, it can be built and installed to a global store, which can be shared across projects. These build products are identified by a hash based on all of the inputs which influence the compilation of a package (flags, dependency selection, etc.). Just as in Nix, these hashes uniquely identify the result of a build; if we compute this identifier and we find that we already have this ID built, we can just use the already built version.
The global package store is
~/.cabal/store (configurable via
global store-dir option); if you need to clear your store for
whatever reason (e.g., to reclaim disk space or because the global
store is corrupted), deleting this directory is safe (
will just rebuild everything it needs on its next invocation).
This split motivates some of the UI choices for Nix-style local build
commands. For example, flags passed to
cabal v2-build are only
applied to local packages, so that adding a flag to
cabal v2-build doesn’t necessitate a rebuild of every transitive
dependency in the global package store.
In cabal-install 2.0 and above, Nix-style local builds also take advantage of a new Cabal library feature, per-component builds, where each component of a package is configured and built separately. This can massively speed up rebuilds of packages with lots of components (e.g., a package that defines multiple executables), as only one executable needs to be rebuilt. Packages that use Custom setup scripts are not currently built on a per-component basis.
5.3.2. Where are my build products?¶
A major deficiency in the current implementation of v2-build is that there is no programmatic way to access the location of build products. The location of the build products is intended to be an internal implementation detail of v2-build, but we also understand that many unimplemented features can only be reasonably worked around by accessing build products directly.
The location where build products can be found varies depending on the version of cabal-install:
- In cabal-install-1.24, the dist directory for a package
p-0.1is stored in
dist-newstyle/build/p-0.1. For example, if you built an executable or test suite named
pexe, it would be located at
- In cabal-install-2.0, the dist directory for a package
p-0.1defining a library built with GHC 8.0.1 on 64-bit Linux is
dist-newstyle/build/x86_64-linux/ghc-8.0.1/p-0.1. When per-component builds are enabled (any non-Custom package), a subcomponent like an executable or test suite named
pexewill be stored at
dist-newstyle/build/x86_64-linux/ghc-8.0.1/p-0.1/c/pexe; thus, the full path of the executable is
dist-newstyle/build/x86_64-linux/ghc-8.0.1/p-0.1/c/pexe/build/pexe/pexe(you can see why we want this to be an implementation detail!)
- In cabal-install-2.2 and above, the
/c/part of the above path is replaced with one of
/b/, depending on the type of component (sublibrary, executable, foreign library, test suite, or benchmark respectively). So the full path to an executable named
pexecompiled with GHC 8.0.1 on a 64-bit Linux is now
dist-newstyle/build/x86_64-linux/ghc-8.0.1/p-0.1/x/pexe/build/pexe/pexe; for a benchmark named
pbenchit now is
The paths are a bit longer in 2.0 and above but the benefit is that you can transparently have multiple builds with different versions of GHC. We plan to add the ability to create aliases for certain build configurations, and more convenient paths to access particularly useful build products like executables.
Nix-style local builds sport a robust caching system which helps to reduce
the time it takes to execute a rebuild cycle. While the details of how
cabal-install does caching are an implementation detail and may
change in the future, knowing what gets cached is helpful for
understanding the performance characteristics of invocations to
v2-build. The cached intermediate results are stored in
dist-newstyle/cache; this folder can be safely deleted to clear the
The following intermediate results are cached in the following files in this folder (the most important two are first):
- The result of calling the dependency solver, assuming that the
Hackage index, local
cabal.projectfile, and local
cabalfiles are unmodified. (Notably, we do NOT have to dependency solve again if new build products are stored in the global store; the invocation of the dependency solver is independent of what is already available in the store.)
- The hashes of all local source files. When all local source files of
a local package are unchanged,
cabal v2-buildwill skip invoking
setup buildentirely (saving us from a possibly expensive call to
ghc --make). The full list of source files participating in compilation is determined using
cabal sdist --list-only. Thus if you do not list all your source files in a Cabal file, Cabal may fail to recompile when you edit them.
config(same format as
- The full project configuration, merged from
cabal.project(and friends) as well as the command line arguments.
- The configuration of the compiler being used to build the project.
solver-plan, but with all non-inplace packages improved into pre-existing copies from the store.
A JSON serialization of the computed install plan intended for integrating
cabalwith external tooling. The cabal-plan package provides a library for parsing
plan.jsonfiles into a Haskell data structure as well as an example tool showing possible applications.
Document JSON schema (including version history of schema)
Note that every package also has a local cache managed by the Cabal
build system, e.g., in