blob: 409587cb79a726840d7b50c7f8a1830f0c34e28f [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 Bodewig1eb9dbb2010-10-26 09:44:59 +000047 <release version="1.2" date="as in SVN" description="Release 1.2">
Stefan Bodewig8c2e5e62011-04-18 04:28:14 +000048 <action type="update" date="2011-04-18">
49 ZipFile now implements finalize which closes the underlying
50 file.
51 </action>
Sebastian Bazley60d6b6a2011-03-23 12:50:15 +000052 <action issue="COMPRESS-117" type="update" date="2011-03-23">
53 Certain tar files not recognised by ArchiveStreamFactory.
54 </action>
Sebastian Bazley9f68b5d2011-03-23 11:17:25 +000055 <action issue="COMPRESS-125" type="fix" date="2011-03-23">
56 BZip2CompressorInputStream throws IOException if underlying stream returns available() == 0.
57 Removed the check.
58 </action>
Sebastian Bazley8376ecf2011-03-23 11:06:43 +000059 <action issue="COMPRESS-127" type="fix" date="2011-03-23">
60 Calling close() on inputStream returned by CompressorStreamFactory.createCompressorInputStream()
61 does not close the underlying input stream.
62 </action>
Stefan Bodewig86aaf842010-10-29 15:03:49 +000063 <action issue="COMPRESS-122" type="add" date="2010-10-29">
64 TarArchiveEntry provides access to the flags that determine
65 whether it is an archived symbolic link, pipe or other
66 "uncommon" file system object.
67 </action>
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +000068 <action issue="COMPRESS-119" type="fix" date="2010-10-26">
Sebastian Bazley7dd43012010-10-28 14:15:27 +000069 TarArchiveOutputStream#finish now writes all buffered data to the stream
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +000070 </action>
71 </release>
72 <release version="1.1" date="2010-08-13" description="Release 1.1">
Sebastian Bazley75c87112010-06-02 11:15:23 +000073 <action issue="COMPRESS-72" type="fix" date="2010-06-02">
74 Move acknowledgements from NOTICE to README
75 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +000076 <action issue="COMPRESS-113" type="fix" date="2010-06-02">
77 TarArchiveEntry.parseTarHeader() includes the trailing space/NUL when parsing the octal size
78 </action>
79 <action issue="COMPRESS-108" type="add" date="2010-05-23">
Sebastian Bazleydfc66382010-05-23 11:53:07 +000080 Command-line interface to list archive contents.
81 Usage: java -jar commons-compress-n.m.jar archive-name [zip|tar|etc]
82 </action>
Sebastian Bazley050db3d2010-05-17 15:09:29 +000083 <action issue="COMPRESS-118" type="fix" date="2010-05-17">
84 TarUtils.parseName does not properly handle characters outside the range 0-127
85 </action>
Sebastian Bazleyc83d9f72010-05-13 10:25:15 +000086 <action issue="COMPRESS-112" type="update" date="2010-05-13">
87 ArArchiveInputStream does not handle GNU extended filename records (//)
88 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +000089 <action issue="COMPRESS-109" type="add" date="2010-05-10">
Sebastian Bazley23bfa662010-05-10 15:10:27 +000090 Tar implementation does not support Pax headers
91 Added support for reading pax headers.
92 Note: does not support global pax headers
Sebastian Bazley27dea242010-05-10 17:42:37 +000093 </action>
Sebastian Bazley23bfa662010-05-10 15:10:27 +000094 <action issue="COMPRESS-107" type="fix" date="2010-05-10">
95 ArchiveStreamFactory does not recognise tar files created by Ant
Sebastian Bazley27dea242010-05-10 17:42:37 +000096 </action>
Sebastian Bazley8fcd06e2010-05-09 20:46:59 +000097 <action issue="COMPRESS-110" type="fix" date="2010-05-09">
98 Support "ustar" prefix field, which is used when file paths are longer
99 than 100 characters.
Sebastian Bazley27dea242010-05-10 17:42:37 +0000100 </action>
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000101 <action type="update" date="2010-04-19" issue="COMPRESS-105">
102 Document that the name of an ZipArchiveEntry determines whether
Sebastian Bazley27dea242010-05-10 17:42:37 +0000103 an entry is considered a directory or not.
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000104 If you don't use the constructor with the File argument the entry's
105 name must end in a "/" in order for the entry to be known as a directory.
106 </action>
Stefan Bodewig03e94a42010-03-19 15:08:23 +0000107 <action type="add" date="2010-03-19" issue="COMPRESS-103">
108 ZipArchiveInputStream can optionally extract data that used
109 the STORED compression method and a data descriptor.
110 Doing so in a stream is not safe in general, so you have to
111 explicitly enable the feature. By default the stream will
112 throw an exception if it encounters such an entry.
113 </action>
Stefan Bodewig62cb9c42010-03-12 16:06:20 +0000114 <action type="fix" date="2010-03-12" issue="COMPRESS-100">
115 ZipArchiveInputStream will throw an exception if it detects an
116 entry that uses a data descriptor for a STORED entry since it
117 cannot reliably find the end of data for this "compression"
118 method.
119 </action>
Stefan Bodewigd7ea9ff2010-03-12 15:35:44 +0000120 <action type="fix" date="2010-03-12" issue="COMPRESS-101">
121 ZipArchiveInputStream should now properly read archives that
122 use data descriptors but without the "unofficial" signature.
123 </action>
Stefan Bodewig30e1cc82010-03-09 11:23:41 +0000124 <action type="add" date="2010-03-09" issue="COMPRESS-98">
125 The ZIP classes will throw specialized exceptions if any
126 attempt is made to read or write data that uses zip features
127 not supported (yet).
128 </action>
Stefan Bodewigade93792010-03-08 12:00:25 +0000129 <action type="add" date="2010-03-08" issue="COMPRESS-99">
130 ZipFile#getEntries returns entries in a predictable order -
131 the order they appear inside the central directory.
132 A new method getEntriesInPhysicalOrder returns entries in
133 order of the entry data, i.e. the order ZipArchiveInputStream
134 would see.
135 </action>
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000136 <action type="add" date="2010-02-19">
Stefan Bodewige0692ec2010-02-24 15:35:47 +0000137 The Archive*Stream and ZipFile classes now have
138 can(Read|Write)EntryData methods that can be used to check
139 whether a given entry's data can be read/written.
Stefan Bodewiga33505b2010-02-19 12:23:27 +0000140 The method currently returns false for ZIP archives if an
141 entry uses an unsupported compression method or encryption.
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000142 </action>
143 <action type="add" date="2010-02-19" issue="COMPRESS-89">
144 The ZIP classes now detect encrypted entries.
145 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000146 <action type="update" date="2010-02-18" issue="COMPRESS-79">
147 Move DOS/Java time conversions into Zip utility class.
148 </action>
Stefan Bodewiga1015f32010-02-18 16:11:13 +0000149 <action type="fix" date="2010-02-18" issue="COMPRESS-74">
150 ZipArchiveInputStream failed to update the number of bytes
151 read properly.
152 </action>
153 <action type="fix" date="2010-02-18">
154 ArchiveInputStream has a new method getBytesRead that should
155 be preferred over getCount since the later may truncate the
156 number of bytes read for big archives.
157 </action>
Stefan Bodewig315b9472010-02-18 14:56:03 +0000158 <action type="fix" date="2010-02-18" issue="COMPRESS-85">
159 The cpio archives created by CpioArchiveOutputStream couldn't
160 be read by many existing native implementations because the
161 archives contained multiple entries with the same inode/device
162 combinations and weren't padded to a blocksize of 512 bytes.
163 </action>
Stefan Bodewig91695e42010-02-16 13:59:03 +0000164 <action type="fix" date="2010-02-16" issue="COMPRESS-73">
165 ZipArchiveEntry, ZipFile and ZipArchiveInputStream are now
166 more lenient when parsing extra fields.
167 </action>
Sebastian Bazley78e0f2c2010-06-01 16:38:13 +0000168 <action issue="COMPRESS-75" type="update" date="2010-02-12">
169 ZipArchiveInputStream does not show location in file where a problem occurred.
170 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000171 <action type="fix" date="2010-02-12" issue="COMPRESS-82">
172 cpio is terribly slow.
173 Documented that buffered streams are needed for performance
174 </action>
Stefan Bodewig292e1852010-03-04 15:54:09 +0000175 <action type="add" date="2010-02-12" issue="COMPRESS-97">
176 Added autodetection of compression format to
177 CompressorStreamFactory.
178 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000179 <action type="fix" date="2010-02-12">
180 Improved exception message if the extra field data in ZIP
181 archives cannot be parsed.
182 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000183 <action type="fix" date="2010-02-11" issue="COMPRESS-17">
184 Tar format unspecified - current support documented.
185 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000186 <action type="add" issue="COMPRESS-95" date="2010-01-29"
Christian Grobmeiere7517b82010-01-29 07:47:21 +0000187 due-to="Joerg Bellmann">
188 Improve ExceptionMessages in ArchiveStreamFactory
189 </action>
Stefan Bodewig5066e9a2010-01-07 09:34:55 +0000190 <action type="fix" issue="COMPRESS-94" date="2010-01-07"
191 due-to="Anon Devs">
192 ZipArchiveEntry's equals method was broken for entries created
193 with the String-arg constructor. This lead to broken ZIP
194 archives if two different entries had the same hash code.
195 </action>
Stefan Bodewigdc3fc472009-10-30 05:29:17 +0000196 <action type="fix" issue="COMPRESS-87" date="2009-10-30"
197 due-to="Antoni Mylka">
198 ZipArchiveInputStream could repeatedly return 0 on read() when
199 the archive was truncated.
200 </action>
Stefan Bodewig7bb5d882009-10-08 12:07:19 +0000201 <action type="fix" issue="COMPRESS-86" date="2009-10-08">
202 Tar archive entries holding the file name for names longer
203 than 100 characters in GNU longfile mode didn't properly
204 specify they'd be using the "oldgnu" extension.
205 </action>
Stefan Bodewig3e2ddad2009-08-25 08:11:44 +0000206 <action type="add" date="2009-08-25">
207 A new constructor of TarArchiveEntry can create entries with
208 names that start with slashes - the default is to strip
209 leading slashes in order to create relative path names.
210 </action>
Stefan Bodewig7be8ef62009-08-01 20:25:13 +0000211 <action issue="COMPRESS-83" type="fix" date="2009-08-01">
212 Delegate all read and write methods in GZip stream in order to
213 speed up operations.
214 </action>
215 <action type="add" date="2009-08-01">
216 ArchiveEntry now has a getLastModifiedDate method.
217 </action>
218 <action type="fix" date="2009-08-01">
219 The ar and cpio streams now properly read and write last
220 modified times.
221 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000222 <action issue="COMPRESS-81" type="fix" date="2009-06-30">
223 TarOutputStream can leave garbage at the end of the archive
224 </action>
Stefan Bodewig47b706e2009-06-30 08:23:08 +0000225 <action issue="COMPRESS-78" type="add" date="2009-06-30"
226 due-to="Jukka Zitting">
227 Add a BZip2Utils class modelled after GZipUtils
228 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000229 </release>
230 <release version="1.0" date="2009-05-21" description="First Public Release">
231 <action dev="all" type="add" date="2009-05-21">
Christian Grobmeier35ac05e2009-05-10 17:32:20 +0000232 Initial release
233 </action>
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +0000234 <action dev="sgoeschl" type="fix">
235 Updating the pom.xml for preparing a move to commons-proper
236 </action>
237 </release>
238 </body>
239</document>