[commit: packages/ghc-prim] master: Add actual documentation for new SPEC type. (8822cfc)

[Simon Peyton-Jones]

Austin, I think this needs a pointer to this in the user manual.  I wouldn't look in GHC.Types when fiddling with SpecConstr!

Simon

| -----Original Message-----
| From: ghc-commits [mailto:ghc-commits-bounces at haskell.org] On Behalf Of
| git at git.haskell.org
| Sent: 25 October 2013 15:34
| To: ghc-commits at haskell.org
| Subject: [commit: packages/ghc-prim] master: Add actual documentation
| for new SPEC type. (8822cfc)
| 
| Repository : ssh://git@git.haskell.org/ghc-prim
| 
| On branch  : master
| Link       :
| http://ghc.haskell.org/trac/ghc/changeset/8822cfce44a3197f6f418563723c9c
| c4760e8db9/ghc-prim
| 
| >---------------------------------------------------------------
| 
| commit 8822cfce44a3197f6f418563723c9cc4760e8db9
| Author: Austin Seipp <austin at well-typed.com>
| Date:   Fri Oct 25 09:33:49 2013 -0500
| 
|     Add actual documentation for new SPEC type.
| 
|     Signed-off-by: Austin Seipp <austin at well-typed.com>
| 
| 
| >---------------------------------------------------------------
| 
| 8822cfce44a3197f6f418563723c9cc4760e8db9
|  GHC/Types.hs |    8 +++++++-
|  1 file changed, 7 insertions(+), 1 deletion(-)
| 
| diff --git a/GHC/Types.hs b/GHC/Types.hs
| index 0e03143..4f97215 100644
| --- a/GHC/Types.hs
| +++ b/GHC/Types.hs
| @@ -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
| 
| _______________________________________________
| ghc-commits mailing list
| ghc-commits at haskell.org
| http://www.haskell.org/mailman/listinfo/ghc-commits