Remove obsolete pre-Haddock-2 `#hide` pragmas
authorHerbert Valerio Riedel <hvr@gnu.org>
Sun, 22 Sep 2013 22:55:06 +0000 (00:55 +0200)
committerHerbert Valerio Riedel <hvr@gnu.org>
Sun, 22 Sep 2013 23:06:39 +0000 (01:06 +0200)
The now obsolete (and redundant) `#hide` pragmas have been superseded by
`{-# OPTIONS_HADDOCK hide #-}` pragmas which are used by most of the
affected modules anyway.

This commit also adds proper `{-# OPTIONS_HADDOCK hide #-}` pragmas to
`GHC.Desugar` and `GHC.IO.Encoding.Iconv` which had only the ineffective
`#hide` annotation.

Signed-off-by: Herbert Valerio Riedel <hvr@gnu.org>
37 files changed:
libraries/base/Control/Monad/ST/Imp.hs
libraries/base/Control/Monad/ST/Lazy/Imp.hs
libraries/base/GHC/Arr.lhs
libraries/base/GHC/Base.lhs
libraries/base/GHC/Conc.lhs
libraries/base/GHC/Conc/IO.hs
libraries/base/GHC/Desugar.hs
libraries/base/GHC/Enum.lhs
libraries/base/GHC/Err.lhs
libraries/base/GHC/Exception.lhs
libraries/base/GHC/Float.lhs
libraries/base/GHC/Float/ConversionUtils.hs
libraries/base/GHC/Float/RealFracMethods.hs
libraries/base/GHC/ForeignPtr.hs
libraries/base/GHC/GHCi.hs
libraries/base/GHC/IO.hs
libraries/base/GHC/IO/Encoding/Iconv.hs
libraries/base/GHC/IO/Handle/Internals.hs
libraries/base/GHC/IO/Handle/Text.hs
libraries/base/GHC/Int.hs
libraries/base/GHC/List.lhs
libraries/base/GHC/Num.lhs
libraries/base/GHC/PArr.hs
libraries/base/GHC/Pack.lhs
libraries/base/GHC/Ptr.lhs
libraries/base/GHC/Read.lhs
libraries/base/GHC/Real.lhs
libraries/base/GHC/ST.lhs
libraries/base/GHC/STRef.lhs
libraries/base/GHC/Show.lhs
libraries/base/GHC/Stable.lhs
libraries/base/GHC/Storable.lhs
libraries/base/GHC/TopHandler.lhs
libraries/base/GHC/Unicode.hs
libraries/base/GHC/Weak.lhs
libraries/base/GHC/Word.hs
libraries/base/System/Posix/Internals.hs

index 1c030e8..984970f 100644 (file)
@@ -17,7 +17,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module Control.Monad.ST.Imp (
         -- * The 'ST' Monad
         ST,             -- abstract, instance of Functor, Monad, Typeable.
index 40f5267..19e8974 100644 (file)
@@ -18,7 +18,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module Control.Monad.ST.Lazy.Imp (
         -- * The 'ST' monad
         ST,
index 702c76d..f310e2e 100644 (file)
@@ -18,7 +18,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Arr (
         Ix(..), Array(..), STArray(..),
 
index 0958eb7..d876202 100644 (file)
@@ -93,7 +93,6 @@ Other Prelude modules are much easier with fewer complex dependencies.
 
 #include "MachDeps.h"
 
--- #hide
 module GHC.Base
         (
         module GHC.Base,
index 0278123..1ba17f2 100644 (file)
@@ -21,9 +21,8 @@
 -- No: #hide, because bits of this module are exposed by the stm package.
 -- However, we don't want this module to be the home location for the
 -- bits it exports, we'd rather have Control.Concurrent and the other
--- higher level modules be the home.  Hence:
+-- higher level modules be the home.  Hence: #not-home
 
--- #not-home
 module GHC.Conc
         ( ThreadId(..)
 
index 6ee23e5..473fd0c 100644 (file)
@@ -25,9 +25,8 @@
 -- No: #hide, because bits of this module are exposed by the stm package.
 -- However, we don't want this module to be the home location for the
 -- bits it exports, we'd rather have Control.Concurrent and the other
--- higher level modules be the home.  Hence:
+-- higher level modules be the home.  Hence: #not-home
 
--- #not-home
 module GHC.Conc.IO
         ( ensureIOManagerIsRunning
         , ioManagerCapabilitiesChanged
index 72553bf..cdea698 100644 (file)
@@ -3,6 +3,7 @@
            , RankNTypes
            , ExistentialQuantification
   #-}
+{-# OPTIONS_HADDOCK hide #-}
 
 -----------------------------------------------------------------------------
 -- |
@@ -18,7 +19,6 @@
 -- 
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Desugar ((>>>), AnnotationWrapper(..), toAnnotationWrapper) where
 
 import Control.Arrow    (Arrow(..))
index 36f05ff..9a94009 100644 (file)
@@ -19,7 +19,6 @@
 
 #include "MachDeps.h"
 
--- #hide
 module GHC.Enum(
         Bounded(..), Enum(..),
         boundedEnumFrom, boundedEnumFromThen,
index 2ec7ab5..f767984 100644 (file)
@@ -22,7 +22,6 @@
 -- 
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Err( absentErr, error, undefined ) where
 import GHC.CString ()
 import GHC.Types
index b878b6c..540df31 100644 (file)
@@ -21,7 +21,6 @@
 -- 
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Exception
        ( Exception(..)    -- Class
        , throw
index 7a4f39a..9519253 100644 (file)
@@ -28,7 +28,6 @@
 
 #include "ieee-flpt.h"
 
--- #hide
 module GHC.Float( module GHC.Float, Float(..), Double(..), Float#, Double#
                 , double2Int, int2Double, float2Int, int2Float )
     where
index c7fcf8d..4d0674f 100644 (file)
@@ -19,7 +19,6 @@
 
 #include "MachDeps.h"
 
--- #hide
 module GHC.Float.ConversionUtils ( elimZerosInteger, elimZerosInt# ) where
 
 import GHC.Base
index c072208..9c71cf1 100644 (file)
@@ -22,7 +22,6 @@
 
 #include "MachDeps.h"
 
--- #hide
 module GHC.Float.RealFracMethods
     ( -- * Double methods
       -- ** Integer results
index daa8be9..58b4f9a 100644 (file)
@@ -21,7 +21,6 @@
 -- 
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.ForeignPtr
   (
         ForeignPtr(..),
index 213a7c5..f66d540 100644 (file)
@@ -17,7 +17,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.GHCi {-# WARNING "This is an unstable interface." #-} (
         GHCiSandboxIO(..), NoIO()
     ) where
index cd71698..2718c83 100644 (file)
@@ -22,7 +22,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.IO (
         IO(..), unIO, failIO, liftIO,
         unsafePerformIO, unsafeInterleaveIO,
index 54f2a2d..d46ade9 100644 (file)
@@ -4,6 +4,7 @@
            , ForeignFunctionInterface
            , NondecreasingIndentation
   #-}
+{-# OPTIONS_HADDOCK hide #-}
 
 -----------------------------------------------------------------------------
 -- |
@@ -19,7 +20,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.IO.Encoding.Iconv (
 #if !defined(mingw32_HOST_OS)
    iconvEncoding, mkIconvEncoding,
index 9248638..db90864 100644 (file)
@@ -26,7 +26,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.IO.Handle.Internals (
   withHandle, withHandle', withHandle_,
   withHandle__', withHandle_', withAllHandles__,
index 6ff3ac1..dbc96a1 100644 (file)
@@ -26,7 +26,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.IO.Handle.Text ( 
         hWaitForInput, hGetChar, hGetLine, hGetContents, hPutChar, hPutStr,
         commitBuffer',       -- hack, see below
index 5d8264a..b9a807e 100644 (file)
@@ -19,7 +19,6 @@
 
 #include "MachDeps.h"
 
--- #hide
 module GHC.Int (
         Int8(..), Int16(..), Int32(..), Int64(..),
         uncheckedIShiftL64#, uncheckedIShiftRA64#
index 9315ecf..5358f15 100644 (file)
@@ -17,7 +17,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.List (
    -- [] (..),          -- built-in syntax; can't be used in export list
 
index 7cfc377..5cdf782 100644 (file)
@@ -16,7 +16,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Num (module GHC.Num, module GHC.Integer) where
 
 import GHC.Base
index 7a229d6..d569aca 100644 (file)
@@ -20,7 +20,6 @@
 --                This will be cleaned up when we change the internal represention of '[::]' to not
 --                rely on a wired-in type constructor.
 
--- #hide
 module GHC.PArr where
 
 import GHC.Base
index 91fa6dd..ba6107e 100644 (file)
@@ -22,7 +22,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Pack
        (
         -- (**) - emitted by compiler.
index 4c9bb01..c959d1e 100644 (file)
@@ -17,7 +17,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Ptr (
         Ptr(..), FunPtr(..),
         nullPtr, castPtr, plusPtr, alignPtr, minusPtr,
index a8494be..582ffea 100644 (file)
@@ -18,7 +18,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Read
   ( Read(..)   -- class
 
index 0d2713f..d70dd81 100644 (file)
@@ -18,7 +18,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Real where
 
 import GHC.Base
index 6f2fba1..5da8b0a 100644 (file)
@@ -16,7 +16,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.ST (
         ST(..), STret(..), STRep,
         fixST, runST, runSTRep,
index 05a91a6..1fbc5a3 100644 (file)
@@ -17,7 +17,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.STRef (
         STRef(..),
         newSTRef, readSTRef, writeSTRef
index cf308cb..45338e8 100644 (file)
@@ -32,7 +32,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Show
         (
         Show(..), ShowS,
index ba72054..a1dde83 100644 (file)
@@ -21,7 +21,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Stable (
         StablePtr(..),
         newStablePtr,
index 119fed6..1366872 100644 (file)
@@ -17,7 +17,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Storable
         ( readWideCharOffPtr  
         , readIntOffPtr       
index 160b8d1..09ab583 100644 (file)
@@ -25,7 +25,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.TopHandler (
         runMainIO, runIO, runIOFastExit, runNonIO,
         topHandler, topHandlerFastExit,
index 6b124ad..07ddc59 100644 (file)
@@ -18,7 +18,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Unicode (
         isAscii, isLatin1, isControl,
         isAsciiUpper, isAsciiLower,
index b3ae376..bffd9f8 100644 (file)
@@ -23,7 +23,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module GHC.Weak (
         Weak(..),
         mkWeak,
index d2568ea..86978dc 100644 (file)
@@ -19,7 +19,6 @@
 
 #include "MachDeps.h"
 
--- #hide
 module GHC.Word (
     Word(..), Word8(..), Word16(..), Word32(..), Word64(..),
     uncheckedShiftL64#,
index 833366e..1869f75 100644 (file)
@@ -21,7 +21,6 @@
 --
 -----------------------------------------------------------------------------
 
--- #hide
 module System.Posix.Internals where
 
 #include "HsBaseConfig.h"