Polish changelog

Author: Bodigrim

changelog.md

@@ -1,69 +1,89 @@
-See also http://pvp.haskell.org/faq
-
-0.6.0.0 *TODO*
-
-  * Add offending path as new field to `TarBombError` constructor
-  * Add `Traversable Entries` instance
-  * Speed up `fromTarPath`, `fromTarPathToPosixPath` and `fromTarPathToWindowsPath`
-  * Set permissions on extracted files
-  * Handle > 8 GB files
-  * Prohibit non-ASCII file names instead of silent corruption
-  * Fix tests on 32-bit architectures
-  * Alleviate leakage of file handles in `packFileEntry`
-  * Add support for over-long filepaths via GNU extension
-  * Add `toTarPath'`, `ToTarPathResult`, `longLinkEntry`, `longSymLinkEntry`
-  * Fix handling of hardlinks and symlinks
-  * Add `packSymlinkEntry` and `symbolicLinkPermission`
-  * Ignore FAT32 errors when setting modification time
-  * Switch to trailer parsing mode only after a full block of `NUL`
-  * Drop deprecated `emptyIndex` and `finaliseIndex`
-  * Extend `FileNameError` with `UnsafeLinkTarget` constructor
-  * Redesign `Codec.Archive.Tar.Check`
-  * Add `packAndCheck` and `unpackAndCheck`
-  * Generalize `Entries`, `Entry` and `EntryContent` to `GenEntries`, `GenEntry` and `GenEntryContent`
-
-0.5.1.1 Herbert Valerio Riedel <[email protected]> August 2019
+## 0.6.0.0 Bodigrim <[email protected]> December 2023
+
+  This release features support for long file paths and symlinks
+  (thanks to Julian Ospald) and variety of changes and improvements
+  across entire package, fixing multiple causes of silent data corruption.
+
+  Breaking changes:
+
+  * Generalize `Entries`, `Entry` and `EntryContent` to `GenEntries`, `GenEntry` and `GenEntryContent`.
+    * Functions working on entries have been generalized to more polymorphic types,
+      where possible.
+    * Modules which used to `import Codec.Archive.Tar (Entry(..))` should now
+      `import Codec.Archive.Tar (GenEntry(..), Entry)` and similar for other `Gen`-types.
+  * Redesign `Codec.Archive.Tar.Check`.
+    * Change types of `checkSecurity`, `checkTarbomb`, `checkPortability`.
+    * Add offending path as new field to `TarBombError` constructor.
+    * Extend `FileNameError` with `UnsafeLinkTarget` constructor.
+  * Drop deprecated `emptyIndex` and `finaliseIndex`.
+
+  Bug fixes:
+
+  * Add support for over-long filepaths via GNU extension.
+  * Fix handling of hardlinks and symlinks.
+  * Handle > 8 GB files insted of silent corruption.
+  * Prohibit non-ASCII file names instead of silent corruption.
+  * Set permissions on extracted files.
+  * Ignore FAT32 errors when setting modification time.
+  * Switch to trailer parsing mode only after a full block of `NUL`.
+
+  New API:
+
+  * Add `Traversable Entries` instance.
+  * Add `toTarPath'`, `ToTarPathResult`, `longLinkEntry`, `longSymLinkEntry`.
+  * Add `packSymlinkEntry` and `symbolicLinkPermission`.
+  * Add `packAndCheck` and `unpackAndCheck`.
+  * Add `checkEntrySecurity`, `checkEntryTarbomb` and `checkEntryPortability`.
+  * Add `encodeLongNames`, `decodeLongNames`, `DecodeLongNamesError`.
+
+  Improvements:
+
+  * Speed up `fromTarPath`, `fromTarPathToPosixPath` and `fromTarPathToWindowsPath`.
+  * Alleviate leakage of file handles in `packFileEntry`.
+  * Fix tests on 32-bit architectures.
+
+## 0.5.1.1 Herbert Valerio Riedel <[email protected]> August 2019
 
   * Add support for GHC 8.8.1 / base-4.13
 
-0.5.1.0 Herbert Valerio Riedel <[email protected]> March 2018
+## 0.5.1.0 Herbert Valerio Riedel <[email protected]> March 2018
 
   * Add support for GHC 8.4.1 / base-4.11
   * Add `Semigroup` instance for `Entries`
 
-0.5.0.3 Duncan Coutts <[email protected]> May 2016
+## 0.5.0.3 Duncan Coutts <[email protected]> May 2016
 
   * Fix tarbomb logic to ignore special PAX entries. Was breaking many
     valid tarballs. https://github.com/haskell/cabal/issues/3390
 
-0.5.0.2 Duncan Coutts <[email protected]> April 2016
+## 0.5.0.2 Duncan Coutts <[email protected]> April 2016
 
   * Fix compatability when using ghc-7.4.x and directory >= 1.2.3
 
-0.5.0.1 Duncan Coutts <[email protected]> January 2016
+## 0.5.0.1 Duncan Coutts <[email protected]> January 2016
 
   * Fix compatability with directory-1.2.3+
 
-0.5.0.0 Duncan Coutts <[email protected]> January 2016
+## 0.5.0.0 Duncan Coutts <[email protected]> January 2016
 
   * Work with old version of bytestring (using bytestring-builder package).
   * Builds with GHC 6.10 -- 8.0.
   * Change type of Index.serialise to be simply strict bytestring.
   * Preserve file timestamps on unpack (with directory-1.2.3+)
 
-0.4.5.0 Duncan Coutts <[email protected]> January 2016
+## 0.4.5.0 Duncan Coutts <[email protected]> January 2016
 
   * Revert accidental minor API change in 0.4.x series (the type of the
     owner and group name strings). The 0.4.3.0 and 0.4.4.0 releases
     contained the accidental API change.
   * Add a handy foldlEntries function
 
-0.4.4.0 Duncan Coutts <[email protected]> January 2016
+## 0.4.4.0 Duncan Coutts <[email protected]> January 2016
 
   * Build and warning fixes for GHC 7.10 and 8.0
   * New Index module function `toList` to get all index entries
 
-0.4.3.0 Duncan Coutts <[email protected]> January 2016
+## 0.4.3.0 Duncan Coutts <[email protected]> January 2016
 
   * New Index function `unfinalise` to extend existing index
   * 9x  faster reading
@@ -74,32 +94,32 @@ See also http://pvp.haskell.org/faq
   * Greater QC test coverage
   * Fix minor bug in reading non-standard v7 format entries
 
-0.4.2.2 Edsko de Vries <[email protected]> October 2015
+## 0.4.2.2 Edsko de Vries <[email protected]> October 2015
 
   * Fix bug in Index
 
-0.4.2.1 Duncan Coutts <[email protected]> July 2015
+## 0.4.2.1 Duncan Coutts <[email protected]> July 2015
 
   * Fix tests for the Index modules (the code was right)
 
-0.4.2.0 Duncan Coutts <[email protected]> July 2015
+## 0.4.2.0 Duncan Coutts <[email protected]> July 2015
 
   * New Index module for random access to tar file contents
   * New lower level tar file I/O actions
   * New tarball file 'append' action
 
-0.4.1.0 Duncan Coutts <[email protected]> January 2015
+## 0.4.1.0 Duncan Coutts <[email protected]> January 2015
 
   * Build with GHC 7.10
   * Switch from old-time to time package
   * Added more instance for Entries type
 
-0.4.0.1 Duncan Coutts <[email protected]> October 2012
+## 0.4.0.1 Duncan Coutts <[email protected]> October 2012
 
   * fixes to work with directory 1.2
   * More Eq/Ord instances
 
-0.4.0.0 Duncan Coutts <[email protected]> February 2012
+## 0.4.0.0 Duncan Coutts <[email protected]> February 2012
 
   * More explicit error types and error handling
   * Support star base-256 number format

tar.cabal

@@ -4,7 +4,7 @@ license:         BSD3
 license-file:    LICENSE
 author:          Duncan Coutts <[email protected]>
                  Bjorn Bringert <[email protected]>
-maintainer:      Duncan Coutts <[email protected]>
+maintainer:      Bodigrim <[email protected]>
 bug-reports:     https://github.com/haskell/tar/issues
 copyright:       2007 Bjorn Bringert <[email protected]>
                  2008-2016 Duncan Coutts <[email protected]>