git.iko.soy/text
on master help sign in
Update text.cabal file & README
64054e7Herbert Valerio Riedel
README.markdown+2−13
compare with master
unifiedsplit
@@ -1,20 +1,9 @@
1−# Text: Fast, packed Unicode strings, using stream fusion
1+# `text`: Fast, packed Unicode strings, using stream fusion
2
2
3This package provides the Data.Text library, a library for the space-
3This package provides the Data.Text library, a library for the space-
4and time-efficient manipulation of Unicode text in Haskell.
4and time-efficient manipulation of Unicode text in Haskell.
5
5
6−
7−# Normalization, conversion, and collation, oh my!
8−
9−This library intentionally provides a simple API based on the
10−Haskell prelude's list manipulation functions. For more complicated
11−real-world tasks, such as Unicode normalization, conversion to and
12−from a larger variety of encodings, and collation, use the [text-icu
13−package](http://hackage.haskell.org/cgi-bin/hackage-scripts/package/text-icu).
6+**Please refer to the [package description on Hackage](https://hackage.haskell.org/package/text#description) for more information.**
14−
15−That library uses the well-respected and liberally licensed ICU
16−library to provide these facilities.
17−
18
7
19# Get involved!
8# Get involved!
20
9
text.cabal+80−10
@@ -14,11 +14,13 @@ description:
14 in terms of large data quantities and high speed.
14 in terms of large data quantities and high speed.
15 .
15 .
16 The 'Text' type provides character-encoding, type-safe case
16 The 'Text' type provides character-encoding, type-safe case
17− conversion via whole-string case conversion functions. It also
17+ conversion via whole-string case conversion functions (see "Data.Text").
18− provides a range of functions for converting 'Text' values to and from
18+ It also provides a range of functions for converting 'Text' values to
19− 'ByteStrings', using several standard encodings.
19+ and from 'ByteStrings', using several standard encodings
20+ (see "Data.Text.Encoding").
20 .
21 .
21− Efficient locale-sensitive support for text IO is also supported.
22+ Efficient locale-sensitive support for text IO is also supported
23+ (see "Data.Text.IO").
22 .
24 .
23 These modules are intended to be imported qualified, to avoid name
25 These modules are intended to be imported qualified, to avoid name
24 clashes with Prelude functions, e.g.
26 clashes with Prelude functions, e.g.
@@ -28,8 +30,9 @@ description:
28 To use an extended and very rich family of functions for working
30 To use an extended and very rich family of functions for working
29 with Unicode text (including normalization, regular expressions,
31 with Unicode text (including normalization, regular expressions,
30 non-standard encodings, text breaking, and locales), see
32 non-standard encodings, text breaking, and locales), see
31− the @text-icu@ package:
32− <http://hackage.haskell.org/package/text-icu>
33+ the [text-icu package](https://hackage.haskell.org/package/text-icu)
34+ based on the well-respected and liberally
35+ licensed [ICU library](http://site.icu-project.org/).
33
36
34license: BSD2
37license: BSD2
35license-file: LICENSE
38license-file: LICENSE
@@ -67,7 +70,9 @@ extra-source-files:
67 tests/text-tests.cabal
70 tests/text-tests.cabal
68
71
69flag bytestring-builder
72flag bytestring-builder
73+ description:
74+ Depend on the [bytestring-builder](https://hackage.haskell.org/package/bytestring-builder)
70− description: Depend on the bytestring-builder package for backwards compatibility.
75+ package for backwards compatibility.
71 default: False
76 default: False
72 manual: False
77 manual: False
73
78
@@ -77,7 +82,9 @@ flag developer
77 manual: True
82 manual: True
78
83
79flag integer-simple
84flag integer-simple
85+ description:
80− description: Use the simple integer library instead of GMP
86+ Use the [simple integer library](http://hackage.haskell.org/package/integer-simple)
87+ instead of [integer-gmp](http://hackage.haskell.org/package/integer-gmp)
81 default: False
88 default: False
82 manual: False
89 manual: False
83
90
@@ -162,8 +169,6 @@ library
162
169
163test-suite tests
170test-suite tests
164 type: exitcode-stdio-1.0
171 type: exitcode-stdio-1.0
165− hs-source-dirs: tests .
166− main-is: Tests.hs
167 c-sources: cbits/cbits.c
172 c-sources: cbits/cbits.c
168 include-dirs: include
173 include-dirs: include
169
174
@@ -173,6 +178,71 @@ test-suite tests
173 cpp-options:
178 cpp-options:
174 -DASSERTS -DHAVE_DEEPSEQ -DTEST_SUITE
179 -DASSERTS -DHAVE_DEEPSEQ -DTEST_SUITE
175
180
181+ -- modules specific to test-suite
182+ hs-source-dirs: tests
183+ main-is: Tests.hs
184+ other-modules:
185+ Tests.Properties
186+ Tests.Properties.Mul
187+ Tests.QuickCheckUtils
188+ Tests.Regressions
189+ Tests.SlowFunctions
190+ Tests.Utils
191+
192+ -- Same as in `library` stanza; this is needed by cabal for accurate
193+ -- file-monitoring as well as to avoid `-Wmissing-home-modules`
194+ -- warnings We can't use an inter-package library dependency because
195+ -- of different `ghc-options`/`cpp-options` (as a side-benefitt,
196+ -- this enables per-component build parallelism in `cabal
197+ -- new-build`!); We could, however, use cabal-version:2.2's `common`
198+ -- blocks at some point in the future to reduce the duplication.
199+ hs-source-dirs: .
200+ other-modules:
201+ Data.Text
202+ Data.Text.Array
203+ Data.Text.Encoding
204+ Data.Text.Encoding.Error
205+ Data.Text.Foreign
206+ Data.Text.IO
207+ Data.Text.Internal
208+ Data.Text.Internal.Builder
209+ Data.Text.Internal.Builder.Functions
210+ Data.Text.Internal.Builder.Int.Digits
211+ Data.Text.Internal.Builder.RealFloat.Functions
212+ Data.Text.Internal.Encoding.Fusion
213+ Data.Text.Internal.Encoding.Fusion.Common
214+ Data.Text.Internal.Encoding.Utf16
215+ Data.Text.Internal.Encoding.Utf32
216+ Data.Text.Internal.Encoding.Utf8
217+ Data.Text.Internal.Functions
218+ Data.Text.Internal.Fusion
219+ Data.Text.Internal.Fusion.CaseMapping
220+ Data.Text.Internal.Fusion.Common
221+ Data.Text.Internal.Fusion.Size
222+ Data.Text.Internal.Fusion.Types
223+ Data.Text.Internal.IO
224+ Data.Text.Internal.Lazy
225+ Data.Text.Internal.Lazy.Encoding.Fusion
226+ Data.Text.Internal.Lazy.Fusion
227+ Data.Text.Internal.Lazy.Search
228+ Data.Text.Internal.Private
229+ Data.Text.Internal.Read
230+ Data.Text.Internal.Search
231+ Data.Text.Internal.Unsafe
232+ Data.Text.Internal.Unsafe.Char
233+ Data.Text.Internal.Unsafe.Shift
234+ Data.Text.Lazy
235+ Data.Text.Lazy.Builder
236+ Data.Text.Lazy.Builder.Int
237+ Data.Text.Lazy.Builder.RealFloat
238+ Data.Text.Lazy.Encoding
239+ Data.Text.Lazy.IO
240+ Data.Text.Lazy.Internal
241+ Data.Text.Lazy.Read
242+ Data.Text.Read
243+ Data.Text.Unsafe
244+ Data.Text.Show
245+
176 build-depends:
246 build-depends:
177 HUnit >= 1.2,
247 HUnit >= 1.2,
178 QuickCheck >= 2.7 && < 2.10,
248 QuickCheck >= 2.7 && < 2.10,