blob: 03f1fce17de2f1ddb77b9cae21cd9739c3abdea4 [file] [log] [blame]
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +00001<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 Licensed to the Apache Software Foundation (ASF) under one
4 or more contributor license agreements. See the NOTICE file
5 distributed with this work for additional information
6 regarding copyright ownership. The ASF licenses this file
7 to you under the Apache License, Version 2.0 (the
8 "License"); you may not use this file except in compliance
9 with the License. You may obtain a copy of the License at
10
11 http://www.apache.org/licenses/LICENSE-2.0
12
13 Unless required by applicable law or agreed to in writing,
14 software distributed under the License is distributed on an
15 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 KIND, either express or implied. See the License for the
17 specific language governing permissions and limitations
18 under the License.
19-->
Sebastian Bazley48882f12010-04-13 21:02:37 +000020
21<!--
22This file is also used by the maven-changes-plugin to generate the release notes.
23Useful ways of finding items to add to this file are:
24
Sebastian Bazley27dea242010-05-10 17:42:37 +0000251. Add items when you fix a bug or add a feature (this makes the
Sebastian Bazley48882f12010-04-13 21:02:37 +000026release process easy :-).
27
282. Do a JIRA search for tickets closed since the previous release.
29
303. Use the report generated by the maven-changelog-plugin to see all
31SVN commits. TBA how to use this with SVN.
32
33To generate the release notes from this file:
34
Sebastian Bazley6021ccb2010-04-14 00:49:28 +000035mvn changes:announcement-generate -Prelnotes
Sebastian Bazley48882f12010-04-13 21:02:37 +000036mv target/announcement/release-notes.vm RELEASE-NOTES.txt
Sebastian Bazley27dea242010-05-10 17:42:37 +000037then tweak the formatting if necessary and commit
Sebastian Bazley48882f12010-04-13 21:02:37 +000038
39The <action> type attribute can be add,update,fix,remove.
40-->
41
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +000042<document>
43 <properties>
44 <title>commons-compress</title>
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +000045 </properties>
46 <body>
Stefan Bodewig3447a362011-11-01 06:16:11 +000047 <release version="1.4" date="unreleased"
48 description="Release 1.4">
Stefan Bodewige166fa72011-11-03 06:32:25 +000049 <action issue="COMPRESS-156" type="add" date="2011-11-02">
50 Support for the XZ format has been added.
51 </action>
Stefan Bodewig20fd83a2011-11-07 16:36:51 +000052 <action issue="COMPRESS-146" type="update" date="2011-11-07">
53 BZip2CompressorInputStream now optionally supports reading of
54 concatenated .bz2 files.
55 </action>
Stefan Bodewigfa237cc2011-11-09 16:18:05 +000056 <action issue="COMPRESS-154" type="update" date="2011-11-09">
57 GZipCompressorInputStream now optionally supports reading of
58 concatenated .gz files.
59 </action>
Stefan Bodewig34766062011-12-05 15:39:52 +000060 <action issue="COMPRESS-164" type="fix" date="2011-12-05">
61 ZipFile didn't work properly for archives using unicode extra
62 fields rather than UTF-8 filenames and the EFS-Flag.
63 </action>
Stefan Bodewigc4704be2011-12-07 12:14:59 +000064 <action issue="COMPRESS-16" type="update" date="2011-12-07">
65 The tar package can now read archives that use star/GNU/BSD
66 extensions for files that are longer than 8 GByte as well as
67 archives that use the POSIX/PAX variant.
68 </action>
Stefan Bodewigf90c1cb2011-12-08 16:43:50 +000069 <action issue="COMPRESS-165" type="update" date="2011-12-08">
70 The tar package can now write archives that use star/GNU/BSD
71 extensions for files that are longer than 8 GByte as well as
72 archives that use the POSIX/PAX variant.
73 </action>
74 <action issue="COMPRESS-166" type="update" date="2011-12-08">
75 The tar package can now use the POSIX/PAX variant for writing
76 entries with names longer than 100 characters.
77 </action>
Stefan Bodewig3447a362011-11-01 06:16:11 +000078 </release>
79 <release version="1.3" date="2011-11-01"
Stefan Bodewig7df24262011-07-31 05:43:43 +000080 description="Release 1.3 - API compatible to 1.2 but requires Java5 at runtime">
Stefan Bodewigf4ff2002011-09-14 15:03:35 +000081 <action issue="COMPRESS-142" type="add" date="2011-09-14">
82 Support for the Pack200 format has been added.
83 </action>
Stefan Bodewig67248f02011-08-22 05:47:26 +000084 <action issue="COMPRESS-132" type="add" date="2011-08-17">
85 Read-only support for the format used by the Unix dump(8) tool
86 has been added.
87 </action>
Stefan Bodewig3ae0c502011-08-15 04:13:10 +000088 <action issue="COMPRESS-36" type="update" date="2011-08-15">
89 The ZIP package now supports Zip64 extensions.
90 </action>
Stefan Bodewig1b915c72011-08-08 11:39:41 +000091 <action issue="COMPRESS-144" type="update" date="2011-08-08">
92 The AR package now supports the BSD dialect of storing file
93 names longer than 16 chars (both reading and writing).
94 </action>
Stefan Bodewig02991912011-08-08 04:41:15 +000095 <action type="fix" date="2011-08-08">
Stefan Bodewigc84526b2011-08-08 05:09:25 +000096 BZip2CompressorInputStream's getBytesRead method always
Stefan Bodewig02991912011-08-08 04:41:15 +000097 returned 0.
98 </action>
Stefan Bodewigd48f1062011-08-03 13:36:01 +000099 <action issue="COMPRESS-152" type="fix" date="2011-08-03">
100 ZipArchiveInputStream and ZipArchiveOutputStream could leak
101 resources on some JDKs.
102 </action>
Stefan Bodewigfdac1472011-10-23 12:15:13 +0000103 <action issue="COMPRESS-160" type="fix" date="2011-10-23">
104 TarArchiveOutputStream's getBytesWritten method didn't count
105 correctly.
106 </action>
Stefan Bodewig7df24262011-07-31 05:43:43 +0000107 </release>
108 <release version="1.2" date="2011-07-31"
Stefan Bodewig947e9832011-07-27 03:53:35 +0000109 description="Release 1.2 - a bugfix release, the last release expected to be compatible with Java 1.4">
Stefan Bodewiga9bd2e22011-07-26 14:12:44 +0000110 <action issue="COMPRESS-129" type="fix" date="2011-07-26">
111 ZipArchiveInputStream could fail with a "Truncated ZIP" error
112 message for entries between 2 GByte and 4 GByte in size.
113 </action>
Stefan Bodewigeedeff92011-07-23 04:57:17 +0000114 <action issue="COMPRESS-145" type="fix" date="2011-07-23"
115 due-tue="Patrick Dreyer">
Stefan Bodewig2b90da62011-07-25 05:54:45 +0000116 TarArchiveInputStream now detects sparse entries using the
117 oldgnu format and properly reports it cannot extract their
118 contents.
Stefan Bodewigeedeff92011-07-23 04:57:17 +0000119 </action>
120 <action issue="COMPRESS-123" type="add" date="2011-07-23">
Stefan Bodewig934a96e2011-07-23 04:33:44 +0000121 ZipArchiveEntry has a new method getRawName that provides the
122 original bytes that made up the name. This may allow user
123 code to detect the encoding.
124 </action>
Stefan Bodewig7a76c472011-07-20 14:55:50 +0000125 <action issue="COMPRESS-130" type="fix" date="2011-07-20">
126 The Javadoc for ZipArchiveInputStream#skip now matches the
127 implementation, the code has been made more defensive.
128 </action>
Stefan Bodewig541898f2011-07-20 14:23:20 +0000129 <action issue="COMPRESS-140" type="fix" date="2011-07-20"
130 due-to="Trejkaz">
131 ArArchiveInputStream fails if entries contain only blanks for
132 userId or groupId.
133 </action>
Stefan Bodewigb4d75052011-07-13 13:53:18 +0000134 <action issue="COMPRESS-139" type="fix" date="2011-07-13">
135 ZipFile may leak resources on some JDKs.
136 </action>
Stefan Bodewig8c2e5e62011-04-18 04:28:14 +0000137 <action type="update" date="2011-04-18">
138 ZipFile now implements finalize which closes the underlying
139 file.
140 </action>
Sebastian Bazley60d6b6a2011-03-23 12:50:15 +0000141 <action issue="COMPRESS-117" type="update" date="2011-03-23">
142 Certain tar files not recognised by ArchiveStreamFactory.
143 </action>
Sebastian Bazley9f68b5d2011-03-23 11:17:25 +0000144 <action issue="COMPRESS-125" type="fix" date="2011-03-23">
145 BZip2CompressorInputStream throws IOException if underlying stream returns available() == 0.
146 Removed the check.
147 </action>
Sebastian Bazley8376ecf2011-03-23 11:06:43 +0000148 <action issue="COMPRESS-127" type="fix" date="2011-03-23">
149 Calling close() on inputStream returned by CompressorStreamFactory.createCompressorInputStream()
150 does not close the underlying input stream.
151 </action>
Stefan Bodewig86aaf842010-10-29 15:03:49 +0000152 <action issue="COMPRESS-122" type="add" date="2010-10-29">
153 TarArchiveEntry provides access to the flags that determine
154 whether it is an archived symbolic link, pipe or other
155 "uncommon" file system object.
156 </action>
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +0000157 <action issue="COMPRESS-119" type="fix" date="2010-10-26">
Sebastian Bazley7dd43012010-10-28 14:15:27 +0000158 TarArchiveOutputStream#finish now writes all buffered data to the stream
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +0000159 </action>
160 </release>
161 <release version="1.1" date="2010-08-13" description="Release 1.1">
Sebastian Bazley75c87112010-06-02 11:15:23 +0000162 <action issue="COMPRESS-72" type="fix" date="2010-06-02">
163 Move acknowledgements from NOTICE to README
164 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +0000165 <action issue="COMPRESS-113" type="fix" date="2010-06-02">
166 TarArchiveEntry.parseTarHeader() includes the trailing space/NUL when parsing the octal size
167 </action>
168 <action issue="COMPRESS-108" type="add" date="2010-05-23">
Sebastian Bazleydfc66382010-05-23 11:53:07 +0000169 Command-line interface to list archive contents.
170 Usage: java -jar commons-compress-n.m.jar archive-name [zip|tar|etc]
171 </action>
Sebastian Bazley050db3d2010-05-17 15:09:29 +0000172 <action issue="COMPRESS-118" type="fix" date="2010-05-17">
173 TarUtils.parseName does not properly handle characters outside the range 0-127
174 </action>
Sebastian Bazleyc83d9f72010-05-13 10:25:15 +0000175 <action issue="COMPRESS-112" type="update" date="2010-05-13">
176 ArArchiveInputStream does not handle GNU extended filename records (//)
177 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +0000178 <action issue="COMPRESS-109" type="add" date="2010-05-10">
Sebastian Bazley23bfa662010-05-10 15:10:27 +0000179 Tar implementation does not support Pax headers
180 Added support for reading pax headers.
181 Note: does not support global pax headers
Sebastian Bazley27dea242010-05-10 17:42:37 +0000182 </action>
Sebastian Bazley23bfa662010-05-10 15:10:27 +0000183 <action issue="COMPRESS-107" type="fix" date="2010-05-10">
184 ArchiveStreamFactory does not recognise tar files created by Ant
Sebastian Bazley27dea242010-05-10 17:42:37 +0000185 </action>
Sebastian Bazley8fcd06e2010-05-09 20:46:59 +0000186 <action issue="COMPRESS-110" type="fix" date="2010-05-09">
187 Support "ustar" prefix field, which is used when file paths are longer
188 than 100 characters.
Sebastian Bazley27dea242010-05-10 17:42:37 +0000189 </action>
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000190 <action type="update" date="2010-04-19" issue="COMPRESS-105">
191 Document that the name of an ZipArchiveEntry determines whether
Sebastian Bazley27dea242010-05-10 17:42:37 +0000192 an entry is considered a directory or not.
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000193 If you don't use the constructor with the File argument the entry's
194 name must end in a "/" in order for the entry to be known as a directory.
195 </action>
Stefan Bodewig03e94a42010-03-19 15:08:23 +0000196 <action type="add" date="2010-03-19" issue="COMPRESS-103">
197 ZipArchiveInputStream can optionally extract data that used
198 the STORED compression method and a data descriptor.
199 Doing so in a stream is not safe in general, so you have to
200 explicitly enable the feature. By default the stream will
201 throw an exception if it encounters such an entry.
202 </action>
Stefan Bodewig62cb9c42010-03-12 16:06:20 +0000203 <action type="fix" date="2010-03-12" issue="COMPRESS-100">
204 ZipArchiveInputStream will throw an exception if it detects an
205 entry that uses a data descriptor for a STORED entry since it
206 cannot reliably find the end of data for this "compression"
207 method.
208 </action>
Stefan Bodewigd7ea9ff2010-03-12 15:35:44 +0000209 <action type="fix" date="2010-03-12" issue="COMPRESS-101">
210 ZipArchiveInputStream should now properly read archives that
211 use data descriptors but without the "unofficial" signature.
212 </action>
Stefan Bodewig30e1cc82010-03-09 11:23:41 +0000213 <action type="add" date="2010-03-09" issue="COMPRESS-98">
214 The ZIP classes will throw specialized exceptions if any
215 attempt is made to read or write data that uses zip features
216 not supported (yet).
217 </action>
Stefan Bodewigade93792010-03-08 12:00:25 +0000218 <action type="add" date="2010-03-08" issue="COMPRESS-99">
219 ZipFile#getEntries returns entries in a predictable order -
220 the order they appear inside the central directory.
221 A new method getEntriesInPhysicalOrder returns entries in
222 order of the entry data, i.e. the order ZipArchiveInputStream
223 would see.
224 </action>
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000225 <action type="add" date="2010-02-19">
Stefan Bodewige0692ec2010-02-24 15:35:47 +0000226 The Archive*Stream and ZipFile classes now have
227 can(Read|Write)EntryData methods that can be used to check
228 whether a given entry's data can be read/written.
Stefan Bodewiga33505b2010-02-19 12:23:27 +0000229 The method currently returns false for ZIP archives if an
230 entry uses an unsupported compression method or encryption.
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000231 </action>
232 <action type="add" date="2010-02-19" issue="COMPRESS-89">
233 The ZIP classes now detect encrypted entries.
234 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000235 <action type="update" date="2010-02-18" issue="COMPRESS-79">
236 Move DOS/Java time conversions into Zip utility class.
237 </action>
Stefan Bodewiga1015f32010-02-18 16:11:13 +0000238 <action type="fix" date="2010-02-18" issue="COMPRESS-74">
239 ZipArchiveInputStream failed to update the number of bytes
240 read properly.
241 </action>
242 <action type="fix" date="2010-02-18">
243 ArchiveInputStream has a new method getBytesRead that should
244 be preferred over getCount since the later may truncate the
245 number of bytes read for big archives.
246 </action>
Stefan Bodewig315b9472010-02-18 14:56:03 +0000247 <action type="fix" date="2010-02-18" issue="COMPRESS-85">
248 The cpio archives created by CpioArchiveOutputStream couldn't
249 be read by many existing native implementations because the
250 archives contained multiple entries with the same inode/device
251 combinations and weren't padded to a blocksize of 512 bytes.
252 </action>
Stefan Bodewig91695e42010-02-16 13:59:03 +0000253 <action type="fix" date="2010-02-16" issue="COMPRESS-73">
254 ZipArchiveEntry, ZipFile and ZipArchiveInputStream are now
255 more lenient when parsing extra fields.
256 </action>
Sebastian Bazley78e0f2c2010-06-01 16:38:13 +0000257 <action issue="COMPRESS-75" type="update" date="2010-02-12">
258 ZipArchiveInputStream does not show location in file where a problem occurred.
259 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000260 <action type="fix" date="2010-02-12" issue="COMPRESS-82">
261 cpio is terribly slow.
262 Documented that buffered streams are needed for performance
263 </action>
Stefan Bodewig292e1852010-03-04 15:54:09 +0000264 <action type="add" date="2010-02-12" issue="COMPRESS-97">
265 Added autodetection of compression format to
266 CompressorStreamFactory.
267 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000268 <action type="fix" date="2010-02-12">
269 Improved exception message if the extra field data in ZIP
270 archives cannot be parsed.
271 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000272 <action type="fix" date="2010-02-11" issue="COMPRESS-17">
273 Tar format unspecified - current support documented.
274 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000275 <action type="add" issue="COMPRESS-95" date="2010-01-29"
Christian Grobmeiere7517b82010-01-29 07:47:21 +0000276 due-to="Joerg Bellmann">
277 Improve ExceptionMessages in ArchiveStreamFactory
278 </action>
Stefan Bodewig5066e9a2010-01-07 09:34:55 +0000279 <action type="fix" issue="COMPRESS-94" date="2010-01-07"
280 due-to="Anon Devs">
281 ZipArchiveEntry's equals method was broken for entries created
282 with the String-arg constructor. This lead to broken ZIP
283 archives if two different entries had the same hash code.
284 </action>
Stefan Bodewigdc3fc472009-10-30 05:29:17 +0000285 <action type="fix" issue="COMPRESS-87" date="2009-10-30"
286 due-to="Antoni Mylka">
287 ZipArchiveInputStream could repeatedly return 0 on read() when
288 the archive was truncated.
289 </action>
Stefan Bodewig7bb5d882009-10-08 12:07:19 +0000290 <action type="fix" issue="COMPRESS-86" date="2009-10-08">
291 Tar archive entries holding the file name for names longer
292 than 100 characters in GNU longfile mode didn't properly
293 specify they'd be using the "oldgnu" extension.
294 </action>
Stefan Bodewig3e2ddad2009-08-25 08:11:44 +0000295 <action type="add" date="2009-08-25">
296 A new constructor of TarArchiveEntry can create entries with
297 names that start with slashes - the default is to strip
298 leading slashes in order to create relative path names.
299 </action>
Stefan Bodewig7be8ef62009-08-01 20:25:13 +0000300 <action issue="COMPRESS-83" type="fix" date="2009-08-01">
301 Delegate all read and write methods in GZip stream in order to
302 speed up operations.
303 </action>
304 <action type="add" date="2009-08-01">
305 ArchiveEntry now has a getLastModifiedDate method.
306 </action>
307 <action type="fix" date="2009-08-01">
308 The ar and cpio streams now properly read and write last
309 modified times.
310 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000311 <action issue="COMPRESS-81" type="fix" date="2009-06-30">
312 TarOutputStream can leave garbage at the end of the archive
313 </action>
Stefan Bodewig47b706e2009-06-30 08:23:08 +0000314 <action issue="COMPRESS-78" type="add" date="2009-06-30"
315 due-to="Jukka Zitting">
316 Add a BZip2Utils class modelled after GZipUtils
317 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000318 </release>
319 <release version="1.0" date="2009-05-21" description="First Public Release">
320 <action dev="all" type="add" date="2009-05-21">
Christian Grobmeier35ac05e2009-05-10 17:32:20 +0000321 Initial release
322 </action>
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +0000323 <action dev="sgoeschl" type="fix">
324 Updating the pom.xml for preparing a move to commons-proper
325 </action>
326 </release>
327 </body>
328</document>