[commit: bytestring] ghc-7.6: Reluctantly expose the builder internal modules with a stiff warning (3d910a4)
Paolo Capriotti
p.capriotti at gmail.com
Thu Sep 6 12:29:22 CEST 2012
Repository : ssh://darcs.haskell.org//srv/darcs/packages/bytestring
On branch : ghc-7.6
http://hackage.haskell.org/trac/ghc/changeset/3d910a4ff07b5e4cffe888371d1b516f92b71d49
>---------------------------------------------------------------
commit 3d910a4ff07b5e4cffe888371d1b516f92b71d49
Author: Duncan Coutts <duncan at community.haskell.org>
Date: Wed Sep 5 22:59:41 2012 +0000
Reluctantly expose the builder internal modules with a stiff warning
>---------------------------------------------------------------
Data/ByteString/Builder/Internal.hs | 7 ++++++-
Data/ByteString/Builder/Prim/Internal.hs | 11 +++++++----
bytestring.cabal | 5 +++--
3 files changed, 16 insertions(+), 7 deletions(-)
diff --git a/Data/ByteString/Builder/Internal.hs b/Data/ByteString/Builder/Internal.hs
index 9acf8dc..fdfea77 100644
--- a/Data/ByteString/Builder/Internal.hs
+++ b/Data/ByteString/Builder/Internal.hs
@@ -4,9 +4,14 @@
-- License : BSD3-style (see LICENSE)
--
-- Maintainer : Simon Meier <iridcode at gmail.com>
--- Stability : experimental
+-- Stability : unstable, private
-- Portability : GHC
--
+-- *Warning:* this module is internal. If you find that you need it then please
+-- contact the maintainers and explain what you are trying to do and discuss
+-- what you would need in the public API. It is important that you do this as
+-- the module may not be exposed at all in future releases.
+--
-- Core types and functions for the 'Builder' monoid and its generalization,
-- the 'Put' monad.
--
diff --git a/Data/ByteString/Builder/Prim/Internal.hs b/Data/ByteString/Builder/Prim/Internal.hs
index 3737888..5375fd9 100644
--- a/Data/ByteString/Builder/Prim/Internal.hs
+++ b/Data/ByteString/Builder/Prim/Internal.hs
@@ -5,12 +5,15 @@
-- License : BSD3-style (see LICENSE)
--
-- Maintainer : Simon Meier <iridcode at gmail.com>
--- Stability : experimental
+-- Stability : unstable, private
-- Portability : GHC
--
--- This module is internal. It is only intended to be used by the 'bytestring'
--- and the 'text' library. Please contact the maintainer, if you need to use
--- this module in your library. We are glad to accept patches for further
+-- *Warning:* this module is internal. If you find that you need it please
+-- contact the maintainers and explain what you are trying to do and discuss
+-- what you would need in the public API. It is important that you do this as
+-- the module may not be exposed at all in future releases.
+--
+-- The maintainers are glad to accept patches for further
-- standard encodings of standard Haskell values.
--
-- If you need to write your own builder primitives, then be aware that you are
diff --git a/bytestring.cabal b/bytestring.cabal
index 72835d4..4a27c9e 100644
--- a/bytestring.cabal
+++ b/bytestring.cabal
@@ -79,10 +79,11 @@ library
Data.ByteString.Builder.Extra
Data.ByteString.Builder.Prim
- other-modules:
- Data.ByteString.Builder.ASCII
+ -- perhaps only exposed temporarily
Data.ByteString.Builder.Internal
Data.ByteString.Builder.Prim.Internal
+ other-modules:
+ Data.ByteString.Builder.ASCII
Data.ByteString.Builder.Prim.Binary
Data.ByteString.Builder.Prim.ASCII
Data.ByteString.Builder.Prim.Internal.Floating
More information about the Cvs-libraries
mailing list