[commit: ghc] master: users-guide: Fix various issues in debugging flags section (471b2a0)

git at git.haskell.org git at git.haskell.org
Thu May 31 02:06:20 UTC 2018


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

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/471b2a099a949549558b01f356a063d7ad73a5f4/ghc

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

commit 471b2a099a949549558b01f356a063d7ad73a5f4
Author: Ben Gamari <bgamari.foss at gmail.com>
Date:   Wed May 30 20:38:06 2018 -0400

    users-guide: Fix various issues in debugging flags section
    
    Reviewers: ggreif
    
    Reviewed By: ggreif
    
    Subscribers: rwbarton, thomie, carter, ggreif
    
    Differential Revision: https://phabricator.haskell.org/D4750


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

471b2a099a949549558b01f356a063d7ad73a5f4
 docs/users_guide/debugging.rst | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/docs/users_guide/debugging.rst b/docs/users_guide/debugging.rst
index 370fa4a..dd9af94 100644
--- a/docs/users_guide/debugging.rst
+++ b/docs/users_guide/debugging.rst
@@ -216,11 +216,10 @@ subexpression elimination pass.
     :shortdesc: Dump desugarer output.
     :type: dynamic
 
-    Dump desugarer output. `-ddump-ds` dumps the output after the very simple
-    optimiser has run (which discards a lot of clutter and
-    hence is a sensible default.  `-ddump-ds-preopt` shows
-    the output after desugaring but before the very simple
-    optimiser.
+    Dump desugarer output. :ghc-flag:`-ddump-ds` dumps the output after the very
+    simple optimiser has run (which discards a lot of clutter and hence is a
+    sensible default. :ghc-flag:`-ddump-ds-preopt` shows the output after
+    desugaring but before the very simple optimiser.
 
 
 .. ghc-flag:: -ddump-simpl-iterations
@@ -228,15 +227,14 @@ subexpression elimination pass.
     :type: dynamic
 
     Show the output of each *iteration* of the simplifier (each run of
-    the simplifier has a maximum number of iterations, normally 4). This
-    outputs even more information than ``-ddump-simpl-phases``.
+    the simplifier has a maximum number of iterations, normally 4).
 
 .. ghc-flag:: -ddump-simpl-stats
     :shortdesc: Dump simplifier stats
     :type: dynamic
 
     Dump statistics about how many of each kind of transformation took
-    place. If you add ``-dppr-debug`` you get more detailed information.
+    place. If you add :ghc-flag:`-dppr-debug` you get more detailed information.
 
 .. ghc-flag:: -dverbose-core2core
     :shortdesc: Show output from each core-to-core pass



More information about the ghc-commits mailing list