Updated Stackage Server FAQ (markdown)

snoyberg 2014-12-17 08:11:37 -08:00
parent 01ad4394ee
commit 2156015aae

@ -17,23 +17,14 @@ Now you can set Stackage as your `remote-repo` and run `cabal update`.
# How do I use it with sandboxes?
## hsenv
Stackage Server natively supports cabal both with and without sandboxes. The standard instructions of downloading a `cabal.config` file should work with any cabal release since 1.18 (possibly earlier versions as well).
With hsenv you can simply edit the `.cabal/config` file and replace
the `remote-repo` line with the line indicated on the page of the
snapshot you want to use. Once this is done, run `cabal update` and off you go!
## Cabal sandbox
There is currently no way to specify a remote-repo in a sandbox
yet. There is
[an open issue](https://github.com/haskell/cabal/issues/1884)
for this. Once it is addressed you'll be able to have a snapshot per
sandbox. Until then, you can either use a stackage globally, or embed
your sandbox inside hsenv.
Note that, previously, we used `remote-repo` configuration to enable Stackage, which presented problems with cabal. The cabal.config support bypasses that issue. If you still wish to use `remote-repo` and wish to do so with a sandbox, you'll need cabal-install 1.18.0.6 or later, or 1.20.0.4 or later.
# What's the difference between inclusive and exclusive snapshots?
Note that this terminology is no longer used. However, the standard cabal.config approach gives you the basics of inclusive as described below, while remote-repo gives you exclusive. At this point, cabal.config/inclusive is recommended.
Imagine that Hackage has the following packages and versions:
* foo-1.0