Remove trailing whitespace
[cabal.git] / changelog.d / pr-7386
blob36c81b21e65fd803025304f7e4c6391fbdae8bb7
1 synopsis: Switch to using XDG directories
2 prs: #7386
3 issues: #680
4 significance: significant
6 description: {
8 Cabal/cabal-install now uses the XDG Base Directory Specification to
9 store configuration, caches, and the store.  Specifically,
10 `$XDG_CONFIG_HOME/cabal` stores the configuration file,
11 `$XDG_CACHE_HOME/cabal` stores downloaded packages and similar, and
12 `$XDG_STATE_HOME/cabal` mainly contains the store of compiled
13 packages.  Further, `cabal install will put executables in
14 `~/.local/bin` by default.
16 The `dist`/`dist-newstyle` directories are not affected.
18 On Windows, these XDG paths are mapped to other (hopefully)
19 appropriate locations.  See the Cabal User Guide for information.
21 If the `CABAL_DIR` environment variable is set, the indicated
22 directory will be used to store all Cabal-related files, as in
23 previous versions.
25 Backwards compatibility: If `~/.cabal` already exists, this will be
26 interpreted as `CABAL_DIR=~/.cabal`.  This means that upgrading on an
27 existing system already using cabal-install should not cause any
28 change in behaviour.  An existing system can be migrated by deleting
29 `~/.cabal` (possibly copying `~/.cabal/config` to
30 `~/.config/cabal/config` first).