on master help sign in
Update Changelog.md (#1913)

* Update, reorgainze, move related things together, remove redundant stuff Co-authored-by: Harendra Kumar <harendra@composewell.com>

commitb4c007e839af0c94557bede38558c94a896083c4 authorRanjeet Ranjan <ranjeetr@composewell.com> dateWed 18 Jan 2023, 09:22 (4 years ago) parent833c16a
1 file changed+52−17
docs/User/ProjectRelated/Changelog.md+52−17
docs/User/ProjectRelated/Changelog.md+52−17
@@ -3,32 +3,67 @@
33<!-- See rendered changelog at https://streamly.composewell.com -->
44## 0.9.0 (Unreleased)
55
6−* Remove support for GHC 8.4.*
7−* New modules for unboxed mutable & unboxed immutable arrays are added.
8−* The unboxed arrays now require `Unbox` instead of `Storable` for the stored
9− type. The `Unbox` typeclass can be found in `Streamly.Data.Array`.
6+### Major Changes
107
11−* Following APIs have been renamed in Streamly.Network.Socket module:
12− readWithBufferOf -> readWith
13− readChunksWithBufferOf -> readChunksWith
14− writeWithBufferOf -> writeWith
15− writeChunksWithBufferOf -> writeChunksWith
8+`streamly` package is split into two packages, (1) `streamly-core` that
9+has only GHC boot library depdendecies, and (2) `streamly` that contains
10+higher level operations with additional dependencies.
1611
17−* Signature changed: Streamly.Data.Unfold.fromStream
12+### Breaking Changes
1813
19−* Add `Streamly.Data.Stream.Concurrent` that provide combinators for handling
20− non-serial streams.
14+* Moved the following modules to the `streamly-core` package:
15+ * Streamly.Console.Stdio
16+ * Streamly.Data.Fold
17+ * Streamly.Data.Unfold
18+ * Streamly.FileSystem.Handle
19+ * Streamly.Unicode.Stream
20+* The unboxed arrays now require `Unbox` instead of `Storable` for the stored
21+ type. The `Unbox` typeclass can be found in `Streamly.Data.Array`.
2122* Remove the MonadBase instance of the SerialT type.
23+* In `Streamly.Data.Unfold`, signatures changed:
24+ * `fromStream`
25+ * `replicateM`
26+
27+### Enhancements
28+
29+* Added the following new modules to the `streamly-core` package:
30+ * Streamly.Data.Array.Mut
31+ * Streamly.Data.Array.Generic
32+ * Streamly.Data.Array.Generic.Mut
33+ * Streamly.Data.Parser
34+ * Streamly.FileSystem.Dir
35+ * Streamly.FileSystem.File
36+ * Streamly.Unicode.String
37+ * Streamly.Unicode.Parser
38+* Added the following new modules to the `streamly` package:
39+ * Streamly.Data.Stream.MkType
40+ * Streamly.Data.Stream.Prelude
2241
2342### Deprecations
2443
44+* `Streamly.Data.Array.Foreign` renamed and moved to `Streamly.Data.Array` in
45+ `streamly-core` package. Corresponding internal modules are renamed
46+ accordingly.
2547* In `Streamly.Data.Fold`:
26− * `variance`, and `stdDev` have been deprecated. Please use the
48+ * `head` renamed to `one`.
49+ * `serialWith` renamed to `splitWith`.
50+ * `variance`, and `stdDev` deprecated. Please use the
2751 `streamly-statistics` package instead.
28− * `serialWith` is deprecated. Use `splitWith` instead.
29−* `Streamly.Data.Array.Foreign` is deprecated. Use `Streamly.Data.Array`
30− instead.
31−* The type of `replicateM` in `Streamly.Data.Unfold` is changed.
52+* In `Streamly.Network.Socket`:
53+ * `readWithBufferOf` renamed to `readWith`
54+ * `readChunksWithBufferOf` renamed to `readChunksWith`
55+ * `writeWithBufferOf` renamed to `writeWith`
56+ * `writeChunksWithBufferOf` renamed to `writeChunksWith`
57+* Remove support for GHC 8.4.*
58+
59+### Internal module changes
60+
61+If you cannot find an internal module that you were using, it may have
62+been moved to the `streamly-core` package or may have been renamed.
63+
64+Following modules are moved to `streamly-core` package and renamed:
65+ * Streamly.Internal.Data.Array.Stream.Foreign -> Streamly.Internal.Data.Stream.Chunked
66+ * Streamly.Internal.Data.Array.Stream.Mut.Foreign -> Streamly.Internal.Data.Array.Mut.Stream
3267
3368## 0.8.2 (Mar 2022)
3469