diff options
| author | Ben Gamari <ben@well-typed.com> | 2021-11-24 16:42:48 +0000 |
|---|---|---|
| committer | Ben Gamari <ben@well-typed.com> | 2021-11-29 19:53:33 +0000 |
| commit | e1c5f7b84568529945c42abe96b6994a53630a26 (patch) | |
| tree | 9434d49716dc84513cbc35077b277f273a21f099 | |
| parent | 14e9cab675f5b0abf2c303a0aa455237768103d1 (diff) | |
| download | haskell-wip/T20702.tar.gz | |
users-guide: Describe requirements of DWARF unwindingwip/T20702
As requested in #20702
| -rw-r--r-- | docs/users_guide/debug-info.rst | 10 |
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 -------- |