aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d09b6408516a83d34c9ddd01c2ce6529e61bbf51 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# cabal-helper

`cabal-helper` provides a library which wraps the internal use of
anexecutable to lift the restrictions imposed by linking against versions of
GHC before `7.10`. This has the pleasant side effect of isolating the user
from having to deal with Cabal version changes manually as `cabal-helper`
can simply recompile it's helper program automatically as needed.

`cabal-helper` uses a wrapper executable to compile the actual cabal-helper
executable at runtime while linking against an arbitrary version of
Cabal. This runtime-compiled helper executable is then used to extract
various bits and peices from Cabal's on disk state (dist/setup-config)
written by it's configure command.

In addition to this the wrapper executable also supports installing any
version of Cabal from hackage in case it cannot be found in any available
package database. The wrapper installs these instances of the Cabal library
into a private package database so as to not interfere with the user's
packages.

Furthermore the wrapper supports one special case namely reading a state
file for Cabal itself. This is needed as Cabal compiles it's Setup.hs using
itself and not using any version of Cabal installed in any package database.

`cabal-helper` can compile with `Cabal >= 1.14` but requires `Cabal >= 1.16`
at runtime.

## IRC

If you have any problems, suggestions, comments swing by
[\#ghc-mod (web client)](https://kiwiirc.com/client/irc.freenode.org/ghc-mod) on
Freenode. If you're reporting a bug please also create an issue
[here](https://github.com/DanielG/cabal-helper/issues) so we have a way to
contact you if you don't have time to stay.

Do hang around for a while if no one answers and repeat your question if you
still haven't gotten any answer after a day or so. You're most likely to get an
answer during the day in GMT+1.