From 59b2794550611879362c7170d6005c6b4f08e3c5 Mon Sep 17 00:00:00 2001 From: Ben Gamari Date: Wed, 24 Nov 2021 16:42:48 +0000 Subject: users-guide: Describe requirements of DWARF unwinding As requested in #20702 --- docs/users_guide/debug-info.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs') 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 -------- -- cgit v1.2.1