Add actual documentation for new SPEC type.
authorAustin Seipp <austin@well-typed.com>
Fri, 25 Oct 2013 14:33:49 +0000 (09:33 -0500)
committerAustin Seipp <austin@well-typed.com>
Fri, 25 Oct 2013 14:33:49 +0000 (09:33 -0500)
Signed-off-by: Austin Seipp <austin@well-typed.com>
libraries/ghc-prim/GHC/Types.hs

index 0e03143..4f97215 100644 (file)
@@ -155,5 +155,11 @@ isTrue# x = tagToEnum# x
 -- you're reading this in 2023 then things went wrong). See #8326.
 --
 
--- | Lorem ipsum...
+-- | SPEC is used by GHC in the @SpecConstr@ pass in order to inform
+-- the compiler when to be particularly aggressive. In particular, it
+-- tells GHC to specialize regardless of size or the number of
+-- specializations. However, not all loops fall into this category.
+--
+-- Libraries can specify this by using 'SPEC' data type to inform which
+-- loops should be aggressively specialized.
 data SPEC = SPEC | SPEC2