summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2018-11-22 17:20:40 -0500
committerBen Gamari <ben@smart-cactus.org>2018-11-23 12:31:49 -0500
commit937d4847400ab70248b12f644a06d14726048c52 (patch)
treec8a76fc3e1d225b8fd7a30eec6113e928d49cbe5 /docs
parent0a126a32d1bbdb3bb70030a77e01415e19ea8b6e (diff)
downloadhaskell-937d4847400ab70248b12f644a06d14726048c52.tar.gz
users guide: Clarify meanings of -g<n> flags
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/debug-info.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/users_guide/debug-info.rst b/docs/users_guide/debug-info.rst
index ecda4afc6c..91ea07398f 100644
--- a/docs/users_guide/debug-info.rst
+++ b/docs/users_guide/debug-info.rst
@@ -17,9 +17,15 @@ useable by most UNIX debugging tools.
Emit debug information in object code. Currently only DWARF debug
information is supported on x86-64 and i386. Currently debug levels 0
- through 3 are accepted, with 0 disabling debug information production
- and higher numbers producing richer output. If ⟨n⟩ is omitted, level 2
- is assumed.
+ through 3 are accepted:
+
+ * ``-g0``: no debug information produced
+ * ``-g1``: produces stack unwinding records for top-level functions (sufficient for basic backtraces)
+ * ``-g2``: produces stack unwinding records for top-level functions as well
+ as inner blocks (allowing more precise backtraces than with ``-g1``).
+ * ``-g3``: same as ``-g2``.
+
+ If ⟨n⟩ is omitted, level 2 is assumed.
Tutorial