]> git.immae.eu Git - github/fretlink/text-pipes.git/blobdiff - pipes-text.cabal
bump for pipes-4.4
[github/fretlink/text-pipes.git] / pipes-text.cabal
index 56a2688781a2daebd7705659228aa16f385de237..9822fd20bf602ccec1f757f2f2ca013ca63c7940 100644 (file)
@@ -1,17 +1,21 @@
 name:                pipes-text
-version:             0.0.2.0
-synopsis:            Text pipes.
-description:         * This organization of the package follows the rule 
+version:             0.0.2.5
+synopsis:            properly streaming text
+description:         /New in version 0.0.2.x/: The new module @Pipes.Prelude.Text@ exports line-based @Text@ producers and consumers as a drop-in replacement for the @String@ material in @Pipes.Prelude@ and @Pipes.Safe.Prelude@. They can be used as one uses @Pipes.Prelude@ without reference to the rest of this package. See the caveats in the documentation for that module.
+                     .
+                     The organization of this package follows the rule:
                      .
                      * @pipes-text : pipes-bytestring :: text : bytestring@ 
                      .
-                     Familiarity with the other three packages should give one an idea what to expect where. The package has three principal modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library. A fourth module @Pipes.Prelude.Text@ is explained below.
+                     Familiarity with the other three packages should give one an idea what to expect where. The package has three principal modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library.
+                     .
+                     The module @Pipes.Text.IO@ is present as a convenience.  Official pipes IO uses @Pipes.ByteString@ together with the bytestring decoding functions in @Pipes.Text.Encoding@.  In particular, the @Pipes.Text.IO@ functions use Text exceptions, while @Pipes.Text@ uses the standard pipes practice of breaking with a failed parse. Thus, for example, the type of @decodeUtf8@ is
                      .
-                     Note that the module @Pipes.Text.IO@ is present as a convenience (as is @Data.Text.IO@).  Official pipes IO would use @Pipes.ByteString@ together with the bytestring decoding functions in @Pipes.Text.Encoding@.  In particular, the @Pipes.Text.IO@ functions use Text exceptions. 
+                     * @decodeUtf8 :: Monad m => Producer ByteString m r -> Producer Text m (Producer ByteString m r)@
                      .
-                     The fourth module @Pipes.Prelude.Text@ exports line-based Text producers and consumers as a drop-in replacement for the String material in @Pipes.Prelude@ and @Pipes.Safe.Prelude@. They can be used as one uses @Pipes.Prelude@ without reference to the rest of this package. See the caveats in the documentation for that module.
+                     where any unparsed bytes are returned.
                      .
-                     @Pipes.Text.IO@ and @Pipes.Prelude.Text@ use version 0.11.3 or later of the @text@ library. To use a (very) old version of @text@, install with the flag @-fnoio@
+                     @Pipes.Text.IO@ and @Pipes.Prelude.Text@ use version 0.11.3 or later of the @text@ library; older versions of @text@ can be used with the flag @-fnoio@
 
 
 
@@ -40,7 +44,7 @@ library
                        bytestring        >= 0.9.2.1 && < 0.11,
                        text              >= 0.11.2  && < 1.3 ,
                        streaming-commons >= 0.1     && < 0.2 ,  
-                       pipes             >= 4.0     && < 4.2 ,
+                       pipes             >= 4.0     && < 4.4 ,
                        pipes-group       >= 1.0.0   && < 1.1 ,
                        pipes-parse       >= 3.0.0   && < 3.1 ,
                        pipes-safe        >= 2.1     && < 2.3 , 
@@ -49,7 +53,6 @@ library
 
   other-extensions:    RankNTypes
   default-language:    Haskell2010
-  ghc-options: -O2
 
   if !flag(noio)
     exposed-modules:   Pipes.Text.IO, Pipes.Text.Tutorial,  Pipes.Prelude.Text