summaryrefslogtreecommitdiff
path: root/hadrian/doc
diff options
context:
space:
mode:
authorAlp Mestanogullari <alpmestan@gmail.com>2019-04-12 19:47:12 +0200
committerMarge Bot <ben+marge-bot@smart-cactus.org>2019-04-18 08:18:18 -0400
commit4c8a67a4b025774993b80442fb3654c8868c1d24 (patch)
tree42c776d4db782b9e13f68d751e9000c15af9b159 /hadrian/doc
parente28706ea0d7b8115716926d0016cd070ab5ab326 (diff)
downloadhaskell-4c8a67a4b025774993b80442fb3654c8868c1d24.tar.gz
Hadrian: fix ghcDebugged and document it
Diffstat (limited to 'hadrian/doc')
-rw-r--r--hadrian/doc/user-settings.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/hadrian/doc/user-settings.md b/hadrian/doc/user-settings.md
index b6b44521cc..6b1849f479 100644
--- a/hadrian/doc/user-settings.md
+++ b/hadrian/doc/user-settings.md
@@ -114,6 +114,21 @@ devel2WerrorFlavour :: Flavour
devel2WerrorFlavour = werror (developmentFlavour Stage2)
```
+### Linking GHC against the debugged RTS
+
+What was previously achieved by having `GhcDebugged=YES` in `mk/build.mk` can
+be done by defining a custom flavour in the user settings file, one that
+sets the `ghcDebugged` field of `Flavour` to `True`, e.g:
+
+``` haskell
+quickDebug :: Flavour
+quickDebug = quickFlavour { name = "dbg", ghcDebugged = True }
+```
+
+Running `build --flavour=dbg` will build a `quick`-flavoured GHC and link
+GHC, iserv, iserv-proxy and remote-iserv against the debugged RTS, by passing
+`-debug` to the commands that link those executables.
+
## Packages
Users can add and remove packages from particular build stages. As an example,