Repository : ssh://darcs.haskell.org//srv/darcs/packages/bytestring

On branch  : master

http://hackage.haskell.org/trac/ghc/changeset/c1d82efe2ab68a9297b8509e39c4a6ba0aa0656e

>---------------------------------------------------------------

commit c1d82efe2ab68a9297b8509e39c4a6ba0aa0656e
Author: Duncan Coutts <[email protected]>
Date:   Mon Nov 7 11:35:33 2011 +0000

    Update package description and tested-with list
    Liberally borrowed the style of description from the text package.

>---------------------------------------------------------------

 bytestring.cabal |   43 ++++++++++++++++++++++++++++++++-----------
 1 files changed, 32 insertions(+), 11 deletions(-)

diff --git a/bytestring.cabal b/bytestring.cabal
index fe177a6..a802460 100644
--- a/bytestring.cabal
+++ b/bytestring.cabal
@@ -1,16 +1,36 @@
 Name:                bytestring
 Version:             0.9.2.0
-Synopsis:            Fast, packed, strict and lazy byte arrays with a list 
interface
+Synopsis:            Fast, compact, strict and lazy byte strings with a list 
interface
 Description:
-    A time and space-efficient implementation of byte vectors using
-    packed Word8 arrays, suitable for high performance use, both in terms
-    of large data quantities, or high speed requirements. Byte vectors
-    are encoded as strict 'Word8' arrays of bytes, and lazy lists of
-    strict chunks, held in a 'ForeignPtr', and can be passed between C
-    and Haskell with little effort.
+    An efficient compact, immutable byte string type (both strict and lazy)
+    suitable for binary or 8-bit character data.
     .
-    Test coverage data for this library is available at:
-        <http://code.haskell.org/~dons/tests/bytestring/hpc_index.html>
+    The 'ByteString' type represents sequences of bytes or 8-bit characters.
+    It is suitable for high performance use, both in terms of large data
+    quantities, or high speed requirements. The 'ByteStrin'g functions follow
+    the same style as Haskell\'s ordinary lists, so it is easy to convert code
+    from using 'String' to 'ByteString'.
+    .
+    Two 'ByteString' variants are provided:
+    .
+      * Strict 'ByteString's keep the string as a single large array. This
+        makes them convenient for passing data between C and Haskell.
+    .
+      * Lazy 'ByteStrings' use a lazy list of strict chunks which makes it
+        suitable for I\/O streaming tasks.
+    .
+    The @Char8@ modules provide a character-based view of the same
+    underlying 'ByteString' types. This makes it convenient to handle mixed
+    binary and 8-bit character content (which is common in many file formats
+    and network protocols).
+    .
+    'ByteString's are not designed for Unicode. For Unicode strings you should
+    use the 'Text' type from the @text@ package.
+    .
+    These modules are intended to be imported qualified, to avoid name clashes
+    with "Prelude" functions, e.g.
+    .
+    > import qualified Data.ByteString as BS
 
 License:             BSD3
 License-file:        LICENSE
@@ -24,7 +44,8 @@ Maintainer:          Don Stewart <[email protected]>,
                      Duncan Coutts <[email protected]>
 Bug-reports:         [email protected],
                      [email protected]
-Tested-With:         GHC==7.0.2, GHC==6.12.3, GHC==6.10.4, GHC ==6.8.2
+Tested-With:         GHC==7.2.1, GHC==7.0.2, GHC==6.12.3,
+                     GHC==6.10.4, GHC ==6.8.2
 Build-Type:          Simple
 Cabal-Version:       >= 1.8
 extra-source-files:  README TODO



_______________________________________________
Cvs-libraries mailing list
[email protected]
http://www.haskell.org/mailman/listinfo/cvs-libraries

Reply via email to