Improve documentation of INLINE, esp its interactions with other transformations

[ghc-hetmet.git] / compiler / simplCore / FloatOut.lhs

diff --git a/compiler/simplCore/FloatOut.lhs b/compiler/simplCore/FloatOut.lhs
index deefe90..7cac08d 100644 (file)
--- a/compiler/simplCore/FloatOut.lhs
+++ b/compiler/simplCore/FloatOut.lhs
@@ -6,11 +6,11 @@
 ``Long-distance'' floating of bindings towards the top level.
 
 \begin{code}
-{-# OPTIONS_GHC -w #-}
+{-# OPTIONS -w #-}
 -- The above warning supression flag is a temporary kludge.
 -- While working on this module you are encouraged to remove it and fix
 -- any warnings in the module. See
---     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
+--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
 -- for details
 
 module FloatOut ( floatOutwards ) where
@@ -321,7 +321,9 @@ floatExpr lvl (Note InlineMe expr)  -- Other than SCCs
        -- more efficient to test once here than to avoid putting
        -- them into floating_defns (which would mean testing for
        -- inlineCtxt  at every let)
-    (fs, [], Note InlineMe (install floating_defns expr')) }   -- See notes in SetLevels
+    (fs, [], Note InlineMe (install floating_defns expr')) }
+       -- See Note [FloatOut inside INLINE]
+       -- I'm guessing that floating_dens should be empty
 
 floatExpr lvl (Note note expr) -- Other than SCCs
   = case (floatExpr lvl expr)    of { (fs, floating_defns, expr') ->