[commit: ghc] master: users guide: Clarify meanings of -g<n> flags (937d484)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/937d4847400ab70248b12f644a06d14726048c52/ghc

>---------------------------------------------------------------

commit 937d4847400ab70248b12f644a06d14726048c52
Author: Ben Gamari <ben at smart-cactus.org>
Date:   Thu Nov 22 17:20:40 2018 -0500

    users guide: Clarify meanings of -g<n> flags


>---------------------------------------------------------------

937d4847400ab70248b12f644a06d14726048c52
 docs/users_guide/debug-info.rst | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/docs/users_guide/debug-info.rst b/docs/users_guide/debug-info.rst
index ecda4af..91ea073 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