summaryrefslogtreecommitdiff
path: root/doc/install/cabal.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/install/cabal.mdwn')
-rw-r--r--doc/install/cabal.mdwn18
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/install/cabal.mdwn b/doc/install/cabal.mdwn
index 6c5c0d4c6..3270dd0f9 100644
--- a/doc/install/cabal.mdwn
+++ b/doc/install/cabal.mdwn
@@ -1,4 +1,14 @@
-As a haskell package, git-annex can be installed using cabal.
+As a haskell package, git-annex can be installed using cabal.
+
+This involves building a lot of haskell packages from source, and so it has
+a lot of moving parts, and it's not uncommon for it to be broken from time
+to time.
+
+If you are not comfortable tracking down and dealing with library build
+problems, installing git-annex with cabal is probably not the right choice
+for you!
+
+## prerequisites
Start by installing the [Haskell Platform][]. In Debian, this is as
simple as:
@@ -40,3 +50,9 @@ you want, and use cabal as follows inside its source tree:
cabal configure
cabal build
cabal install --bindir=$HOME/bin
+
+## EKG
+
+When building with cabal, you can optionally enable the
+[[EKG monitoring interface|ekg]]. This is great for debugging resource
+usage problems.