summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2021-11-01 21:18:04 -0400
committerMarge Bot <ben+marge-bot@smart-cactus.org>2021-12-21 01:46:00 -0500
commit00b55bfcd982bed2c9fc02d9c3ca66ba9d41bb5c (patch)
tree7bb39528df6cdb359a45a6726f14e3abd2626157 /docs
parent8ea79a16c57a9fcfd091ab7f4aa457e100fa42b5 (diff)
downloadhaskell-00b55bfcd982bed2c9fc02d9c3ca66ba9d41bb5c.tar.gz
Introduce -dlint flag
As suggested in #20601, this is a short-hand for enabling the usual GHC-internal sanity checks one typically leans on when debugging runtime crashes.
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/debugging.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/users_guide/debugging.rst b/docs/users_guide/debugging.rst
index 50a6c279a4..f0a929df5e 100644
--- a/docs/users_guide/debugging.rst
+++ b/docs/users_guide/debugging.rst
@@ -920,6 +920,18 @@ Checking for consistency
single: consistency checks
single: lint
+.. ghc-flag:: -dlint
+ :shortdesc: Enable several common internal sanity checkers
+ :type: dynamic
+
+ :implies: -dcore-lint, -dstg-lint, -dcmm-lint, -dasm-lint, -fllvm-fill-undef-with-garbage, -debug
+ :since: 9.4.1
+
+ Turn on various heavy-weight intra-pass sanity-checking measures within GHC
+ and its runtime system. Notably, this does not include
+ :ghc-flag:`-falignment-sanitisation` as it incurs a rather hefty runtime
+ cost.
+
.. ghc-flag:: -dcore-lint
:shortdesc: Turn on internal sanity checking
:type: dynamic