summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBen Gamari <ben@well-typed.com>2021-11-24 16:42:48 +0000
committerMarge Bot <ben+marge-bot@smart-cactus.org>2021-12-01 03:11:09 -0500
commit59b2794550611879362c7170d6005c6b4f08e3c5 (patch)
treee668935158b08a3d6c7d79e97c7cf5e3e578e6cd /docs
parentc2cb5e9a72cc97c2ad16217813f5826782541afd (diff)
downloadhaskell-59b2794550611879362c7170d6005c6b4f08e3c5.tar.gz
users-guide: Describe requirements of DWARF unwinding
As requested in #20702
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/debug-info.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/users_guide/debug-info.rst b/docs/users_guide/debug-info.rst
index ff0c9430e4..8679bd84e3 100644
--- a/docs/users_guide/debug-info.rst
+++ b/docs/users_guide/debug-info.rst
@@ -30,6 +30,16 @@ useable by most UNIX debugging tools.
If ⟨n⟩ is omitted, level 2 is assumed.
+Note that for stack unwinding to be reliable, all libraries, including foreign
+libraries and those shipped with GHC such as ``base``, must be compiled with
+unwinding information. GHC binary distributions configured in this way are
+provided for a select number of platforms; other platforms are advised to build
+using Hadrian's ``+debug_info`` flavour transformer. Note as well that the
+built-in unwinding support provided by the ``base`` library's
+:base-ref:`GHC.ExecutionStack` module requires that the runtime system be built
+with ``libdw`` support enabled (using the ``--enable-dwarf-unwind`` flag to
+``configure`` while building the compiler) and a platform which ``libdw``
+supports.
Tutorial
--------