Explain why opt-cmm is not dumped by ddump-cmm-verbose.
authorklebinger.andreas@gmx.at <klebinger.andreas@gmx.at>
Thu, 21 Jun 2018 20:59:46 +0000 (16:59 -0400)
committerBen Gamari <ben@smart-cactus.org>
Fri, 22 Jun 2018 19:58:13 +0000 (15:58 -0400)
We just update the docs to reflect the state of affairs.

opt-cmm is run by the NCG backend so not always run.
ddump-cmm-verbose only dumps passes of the cmm
pipeline so it's not included there. [skip-ci]

Test Plan: doc change

Reviewers: bgamari

Reviewed By: bgamari

Subscribers: rwbarton, thomie, carter

Differential Revision: https://phabricator.haskell.org/D4879

docs/users_guide/debugging.rst

index 8cd7fd9..1a37eae 100644 (file)
@@ -376,12 +376,14 @@ C-\\- representation
 These flags dump various phases of GHC's C-\\- pipeline.
 
 .. ghc-flag:: -ddump-cmm-verbose
-    :shortdesc: Show output from each C-\\- pipeline pass
+    :shortdesc: Show output from main C-\\- pipeline passes
     :type: dynamic
 
-    Dump output from all C-\\- pipeline stages. In case of
+    Dump output from main C-\\- pipeline stages. In case of
     ``.cmm`` compilation this also dumps the result of
-    file parsing.
+    file parsing. Not included are passes run by
+    the chosen backend. Currently only the NCG backends runs
+    additional passes ( :ghc-flag:`-ddump-opt-cmm` ).
 
     Cmm dumps don't include unreachable blocks since we print
     blocks in reverse post-order.