summaryrefslogtreecommitdiff
path: root/compiler
diff options
context:
space:
mode:
authorThomas Schilling <nominolo@googlemail.com>2009-07-22 23:13:42 +0000
committerThomas Schilling <nominolo@googlemail.com>2009-07-22 23:13:42 +0000
commit8a9eb3cd35117c62ac9758d118c6f4109b7330cb (patch)
tree08316f244ebe6a0240bffcb5430fa90dc13325d3 /compiler
parent583b5e8e48503b76396eabe84da6a3c1ba1bf5ad (diff)
downloadhaskell-8a9eb3cd35117c62ac9758d118c6f4109b7330cb.tar.gz
Minor documentation fixes.
Diffstat (limited to 'compiler')
-rw-r--r--compiler/basicTypes/OccName.lhs2
-rw-r--r--compiler/cmm/OptimizationFuel.hs6
-rw-r--r--compiler/deSugar/Desugar.lhs1
3 files changed, 8 insertions, 1 deletions
diff --git a/compiler/basicTypes/OccName.lhs b/compiler/basicTypes/OccName.lhs
index 0736fea35d..b12a07feae 100644
--- a/compiler/basicTypes/OccName.lhs
+++ b/compiler/basicTypes/OccName.lhs
@@ -9,7 +9,7 @@
-- GHC uses several kinds of name internally:
--
-- * 'OccName.OccName' represents names as strings with just a little more information:
--- the "namespace" that the name came from, e.g. the namespace of value, type constructors or
+-- the \"namespace\" that the name came from, e.g. the namespace of value, type constructors or
-- data constructors
--
-- * 'RdrName.RdrName': see "RdrName#name_types"
diff --git a/compiler/cmm/OptimizationFuel.hs b/compiler/cmm/OptimizationFuel.hs
index 83cb84e324..175dcd09b1 100644
--- a/compiler/cmm/OptimizationFuel.hs
+++ b/compiler/cmm/OptimizationFuel.hs
@@ -1,3 +1,9 @@
+-- | Optimisation fuel is used to control the amount of work the optimiser does.
+--
+-- Every optimisation step consumes a certain amount of fuel and stops when
+-- it runs out of fuel. This can be used e.g. to debug optimiser bugs: Run
+-- the optimiser with varying amount of fuel to find out the exact number of
+-- steps where a bug is introduced in the output.
module OptimizationFuel
( OptimizationFuel, canRewriteWithFuel, maybeRewriteWithFuel, oneLessFuel
, OptFuelState, initOptFuelState --, setTotalFuel
diff --git a/compiler/deSugar/Desugar.lhs b/compiler/deSugar/Desugar.lhs
index 18f177ab2e..a92f83c4e8 100644
--- a/compiler/deSugar/Desugar.lhs
+++ b/compiler/deSugar/Desugar.lhs
@@ -48,6 +48,7 @@ import Data.IORef
%************************************************************************
\begin{code}
+-- | Main entry point to the desugarer.
deSugar :: HscEnv -> ModLocation -> TcGblEnv -> IO (Messages, Maybe ModGuts)
-- Can modify PCS by faulting in more declarations