[commit: ghc] master: Explain why opt-cmm is not dumped by ddump-cmm-verbose. (391b0ca)

[git at git.haskell.org]

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

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/391b0caf0211c8f7968d60468e0512116015a10e/ghc

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

commit 391b0caf0211c8f7968d60468e0512116015a10e
Author: klebinger.andreas at gmx.at <klebinger.andreas at gmx.at>
Date:   Thu Jun 21 16:59:46 2018 -0400

    Explain why opt-cmm is not dumped by ddump-cmm-verbose.
    
    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


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

391b0caf0211c8f7968d60468e0512116015a10e
 docs/users_guide/debugging.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/docs/users_guide/debugging.rst b/docs/users_guide/debugging.rst
index 8cd7fd9..1a37eae 100644
--- a/docs/users_guide/debugging.rst
+++ b/docs/users_guide/debugging.rst
@@ -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.