From 314e2574984def361b0128aeae690241cd8bc820 Mon Sep 17 00:00:00 2001 From: Matthew Craven Date: Thu, 15 Feb 2024 14:51:15 -0500 Subject: [PATCH] Prepare changelog for 0.12.1.0 (#658) * WIP: Prepare changelog for 0.12.1.0 * fiddle with CI * Revert "fiddle with CI" This reverts commit 3e220052bb1f98ea574f7a362b98bf96fdc01f7e. * More changelog updates * Mention `pure-haskell` flag in Changelog.md * Add hidden entry for #660 --- Changelog.md | 67 ++++++++++++++++++++++++++++++++++++++++++++---- bytestring.cabal | 2 +- 2 files changed, 63 insertions(+), 6 deletions(-) diff --git a/Changelog.md b/Changelog.md index e9f0aac7d..2dc4b6de6 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,3 +1,65 @@ +[0.13.0.0] — circa 2026-2027 + +* __Breaking Changes__: + * [`Data.Data.dataTypeOf` for `StrictByteString` and `LazyByteString` now returns a `DataType` that uses `AlgRep` instead of `NoRep`.](https://github.com/haskell/bytestring/pull/614) + * This allows utilities like `syb:Data.Generics.Text.gread` to be meaningfully used at these types containing `ByteString`s. + + +[0.12.1.0] — February 2024 + +* [Provisional support has been added for using `bytestring` with GHC's JavaScript back-end.](https://github.com/haskell/bytestring/pull/631) + * This support is relatively un-tested and un-optimised. There may be bugs! Please report any you discover to [`bytestring`'s issue tracker](https://github.com/haskell/bytestring/issues). + * The JavaScript back-end's limited support for the Haskell-C foreign function interface would previously result in many operations failing with errors like `ReferenceError: h$fps_count is not defined`. + * The new `pure-haskell` package flag allows the new fallback Haskell implementations (used to support the JavaScript backend) to be used on most other platforms as well. +* Bug fixes: + * [`stimes 0 sbs :: ShortByteString` now returns the empty `ShortByteString` instead of throwing an exception](https://github.com/haskell/bytestring/pull/611) + * [`stimes 0 b :: Builder` now returns the empty `Builder` instead of throwing an exception](https://github.com/haskell/bytestring/pull/611) + * [Several alignment-related bug fixes](https://github.com/haskell/bytestring/pull/587) + * [Fix a bug in `isValidUtf8`](https://github.com/haskell/bytestring/pull/621) + * [`sconcat @ShortByteString` is no longer terribly inefficient](https://github.com/haskell/bytestring/pull/650) + * [Fix the type on the foreign import used for `Data.ByteString.Short.elemIndex`](https://github.com/haskell/bytestring/pull/661) + * [Ensure that the result of `fromShort` is protected by `mkDeferredByteString`](https://github.com/haskell/bytestring/pull/662) +* Behavior changes: + * [The `Data.Data.Data` instances for `StrictByteString` and `LazyByteString` have been changed:](https://github.com/haskell/bytestring/pull/614) + * `toConstr` now returns the a `pack` pseudo-constructor instead of throwing an exception. + * Due to this pseudo-constructor, `gunfold` can now be meaningfully used at these types. (Previously, it would always raise an exception.) + * These changes allow `syb:Data.Generics.Text.gshow` to be meaningfully used at types containing `ByteString`s. + * [A derived `instance Generic ShortByteString` has been added.](https://github.com/haskell/bytestring/pull/662) + * [`sconcat @Builder` is now lazy in the tail of its input](https://github.com/haskell/bytestring/pull/650) +* Deprecations: + * [`Data.ByteString.Builder.Prim.Internal.storableToF`](https://github.com/haskell/bytestring/pull/649) +* Performance improvements: + * Various raw-binary `Builder` primitives like `intHost` or `word32BE` are much less inefficient on architectures not known to support unaligned writes. ([1](https://github.com/haskell/bytestring/pull/587), [2](https://github.com/haskell/bytestring/pull/645)) + * [Hexadecimal encoding suffers one indirection fewer](https://github.com/haskell/bytestring/pull/624) + * [`Data.ByteString.Lazy.takeEnd` is somewhat faster](https://github.com/haskell/bytestring/pull/629) + * [`Data.ByteString.Lazy.dropEnd` is much faster](https://github.com/haskell/bytestring/pull/629) +* Miscellaneous: + * Various documentation improvements ([1](https://github.com/haskell/bytestring/pull/628), [2](https://github.com/haskell/bytestring/pull/609), [3](https://github.com/haskell/bytestring/pull/612), [4](https://github.com/haskell/bytestring/pull/623), [5](https://github.com/haskell/bytestring/pull/654)) + * [Eta-expand `Data.ByteString.Builder.Internal.empty`](https://github.com/haskell/bytestring/pull/616) + * This can variously help or hurt performance; it undoes the performance changes caused by [CLC proposal 132](https://github.com/haskell/core-libraries-committee/issues/132) with ghc-9.8 and restores the baseline performance seen with older GHCs. + + +[0.12.1.0]: https://github.com/haskell/bytestring/compare/0.12.0.2...0.12.1.0 + [0.12.0.2] — August 2023 * Bug fixes: @@ -36,11 +98,6 @@ * Deprecations: * `Data.ByteString.getLine`: prefer `Data.ByteString.Char8.getLine` * `Data.ByteString.hGetLine`: prefer `Data.ByteString.Char8.hGetLine` - [0.12.0.0]: https://github.com/haskell/bytestring/compare/0.11.5.0...0.12.0.0 diff --git a/bytestring.cabal b/bytestring.cabal index d4bdb04b5..a9482ff54 100644 --- a/bytestring.cabal +++ b/bytestring.cabal @@ -1,5 +1,5 @@ Name: bytestring -Version: 0.12.0.2 +Version: 0.13.0.0 Synopsis: Fast, compact, strict and lazy byte strings with a list interface Description: An efficient compact, immutable byte string type (both strict and lazy)