blob: 78bc125d5d914ba05d572781468c86e01ca4c51b [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 Bodewig934a96e2011-07-23 04:33:44 +000048 <action issue="COMPRESS-123" type="add" date="2011-07.23">
49 ZipArchiveEntry has a new method getRawName that provides the
50 original bytes that made up the name. This may allow user
51 code to detect the encoding.
52 </action>
Stefan Bodewig7a76c472011-07-20 14:55:50 +000053 <action issue="COMPRESS-130" type="fix" date="2011-07-20">
54 The Javadoc for ZipArchiveInputStream#skip now matches the
55 implementation, the code has been made more defensive.
56 </action>
Stefan Bodewig541898f2011-07-20 14:23:20 +000057 <action issue="COMPRESS-140" type="fix" date="2011-07-20"
58 due-to="Trejkaz">
59 ArArchiveInputStream fails if entries contain only blanks for
60 userId or groupId.
61 </action>
Stefan Bodewigb4d75052011-07-13 13:53:18 +000062 <action issue="COMPRESS-139" type="fix" date="2011-07-13">
63 ZipFile may leak resources on some JDKs.
64 </action>
Stefan Bodewig8c2e5e62011-04-18 04:28:14 +000065 <action type="update" date="2011-04-18">
66 ZipFile now implements finalize which closes the underlying
67 file.
68 </action>
Sebastian Bazley60d6b6a2011-03-23 12:50:15 +000069 <action issue="COMPRESS-117" type="update" date="2011-03-23">
70 Certain tar files not recognised by ArchiveStreamFactory.
71 </action>
Sebastian Bazley9f68b5d2011-03-23 11:17:25 +000072 <action issue="COMPRESS-125" type="fix" date="2011-03-23">
73 BZip2CompressorInputStream throws IOException if underlying stream returns available() == 0.
74 Removed the check.
75 </action>
Sebastian Bazley8376ecf2011-03-23 11:06:43 +000076 <action issue="COMPRESS-127" type="fix" date="2011-03-23">
77 Calling close() on inputStream returned by CompressorStreamFactory.createCompressorInputStream()
78 does not close the underlying input stream.
79 </action>
Stefan Bodewig86aaf842010-10-29 15:03:49 +000080 <action issue="COMPRESS-122" type="add" date="2010-10-29">
81 TarArchiveEntry provides access to the flags that determine
82 whether it is an archived symbolic link, pipe or other
83 "uncommon" file system object.
84 </action>
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +000085 <action issue="COMPRESS-119" type="fix" date="2010-10-26">
Sebastian Bazley7dd43012010-10-28 14:15:27 +000086 TarArchiveOutputStream#finish now writes all buffered data to the stream
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +000087 </action>
88 </release>
89 <release version="1.1" date="2010-08-13" description="Release 1.1">
Sebastian Bazley75c87112010-06-02 11:15:23 +000090 <action issue="COMPRESS-72" type="fix" date="2010-06-02">
91 Move acknowledgements from NOTICE to README
92 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +000093 <action issue="COMPRESS-113" type="fix" date="2010-06-02">
94 TarArchiveEntry.parseTarHeader() includes the trailing space/NUL when parsing the octal size
95 </action>
96 <action issue="COMPRESS-108" type="add" date="2010-05-23">
Sebastian Bazleydfc66382010-05-23 11:53:07 +000097 Command-line interface to list archive contents.
98 Usage: java -jar commons-compress-n.m.jar archive-name [zip|tar|etc]
99 </action>
Sebastian Bazley050db3d2010-05-17 15:09:29 +0000100 <action issue="COMPRESS-118" type="fix" date="2010-05-17">
101 TarUtils.parseName does not properly handle characters outside the range 0-127
102 </action>
Sebastian Bazleyc83d9f72010-05-13 10:25:15 +0000103 <action issue="COMPRESS-112" type="update" date="2010-05-13">
104 ArArchiveInputStream does not handle GNU extended filename records (//)
105 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +0000106 <action issue="COMPRESS-109" type="add" date="2010-05-10">
Sebastian Bazley23bfa662010-05-10 15:10:27 +0000107 Tar implementation does not support Pax headers
108 Added support for reading pax headers.
109 Note: does not support global pax headers
Sebastian Bazley27dea242010-05-10 17:42:37 +0000110 </action>
Sebastian Bazley23bfa662010-05-10 15:10:27 +0000111 <action issue="COMPRESS-107" type="fix" date="2010-05-10">
112 ArchiveStreamFactory does not recognise tar files created by Ant
Sebastian Bazley27dea242010-05-10 17:42:37 +0000113 </action>
Sebastian Bazley8fcd06e2010-05-09 20:46:59 +0000114 <action issue="COMPRESS-110" type="fix" date="2010-05-09">
115 Support "ustar" prefix field, which is used when file paths are longer
116 than 100 characters.
Sebastian Bazley27dea242010-05-10 17:42:37 +0000117 </action>
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000118 <action type="update" date="2010-04-19" issue="COMPRESS-105">
119 Document that the name of an ZipArchiveEntry determines whether
Sebastian Bazley27dea242010-05-10 17:42:37 +0000120 an entry is considered a directory or not.
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000121 If you don't use the constructor with the File argument the entry's
122 name must end in a "/" in order for the entry to be known as a directory.
123 </action>
Stefan Bodewig03e94a42010-03-19 15:08:23 +0000124 <action type="add" date="2010-03-19" issue="COMPRESS-103">
125 ZipArchiveInputStream can optionally extract data that used
126 the STORED compression method and a data descriptor.
127 Doing so in a stream is not safe in general, so you have to
128 explicitly enable the feature. By default the stream will
129 throw an exception if it encounters such an entry.
130 </action>
Stefan Bodewig62cb9c42010-03-12 16:06:20 +0000131 <action type="fix" date="2010-03-12" issue="COMPRESS-100">
132 ZipArchiveInputStream will throw an exception if it detects an
133 entry that uses a data descriptor for a STORED entry since it
134 cannot reliably find the end of data for this "compression"
135 method.
136 </action>
Stefan Bodewigd7ea9ff2010-03-12 15:35:44 +0000137 <action type="fix" date="2010-03-12" issue="COMPRESS-101">
138 ZipArchiveInputStream should now properly read archives that
139 use data descriptors but without the "unofficial" signature.
140 </action>
Stefan Bodewig30e1cc82010-03-09 11:23:41 +0000141 <action type="add" date="2010-03-09" issue="COMPRESS-98">
142 The ZIP classes will throw specialized exceptions if any
143 attempt is made to read or write data that uses zip features
144 not supported (yet).
145 </action>
Stefan Bodewigade93792010-03-08 12:00:25 +0000146 <action type="add" date="2010-03-08" issue="COMPRESS-99">
147 ZipFile#getEntries returns entries in a predictable order -
148 the order they appear inside the central directory.
149 A new method getEntriesInPhysicalOrder returns entries in
150 order of the entry data, i.e. the order ZipArchiveInputStream
151 would see.
152 </action>
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000153 <action type="add" date="2010-02-19">
Stefan Bodewige0692ec2010-02-24 15:35:47 +0000154 The Archive*Stream and ZipFile classes now have
155 can(Read|Write)EntryData methods that can be used to check
156 whether a given entry's data can be read/written.
Stefan Bodewiga33505b2010-02-19 12:23:27 +0000157 The method currently returns false for ZIP archives if an
158 entry uses an unsupported compression method or encryption.
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000159 </action>
160 <action type="add" date="2010-02-19" issue="COMPRESS-89">
161 The ZIP classes now detect encrypted entries.
162 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000163 <action type="update" date="2010-02-18" issue="COMPRESS-79">
164 Move DOS/Java time conversions into Zip utility class.
165 </action>
Stefan Bodewiga1015f32010-02-18 16:11:13 +0000166 <action type="fix" date="2010-02-18" issue="COMPRESS-74">
167 ZipArchiveInputStream failed to update the number of bytes
168 read properly.
169 </action>
170 <action type="fix" date="2010-02-18">
171 ArchiveInputStream has a new method getBytesRead that should
172 be preferred over getCount since the later may truncate the
173 number of bytes read for big archives.
174 </action>
Stefan Bodewig315b9472010-02-18 14:56:03 +0000175 <action type="fix" date="2010-02-18" issue="COMPRESS-85">
176 The cpio archives created by CpioArchiveOutputStream couldn't
177 be read by many existing native implementations because the
178 archives contained multiple entries with the same inode/device
179 combinations and weren't padded to a blocksize of 512 bytes.
180 </action>
Stefan Bodewig91695e42010-02-16 13:59:03 +0000181 <action type="fix" date="2010-02-16" issue="COMPRESS-73">
182 ZipArchiveEntry, ZipFile and ZipArchiveInputStream are now
183 more lenient when parsing extra fields.
184 </action>
Sebastian Bazley78e0f2c2010-06-01 16:38:13 +0000185 <action issue="COMPRESS-75" type="update" date="2010-02-12">
186 ZipArchiveInputStream does not show location in file where a problem occurred.
187 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000188 <action type="fix" date="2010-02-12" issue="COMPRESS-82">
189 cpio is terribly slow.
190 Documented that buffered streams are needed for performance
191 </action>
Stefan Bodewig292e1852010-03-04 15:54:09 +0000192 <action type="add" date="2010-02-12" issue="COMPRESS-97">
193 Added autodetection of compression format to
194 CompressorStreamFactory.
195 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000196 <action type="fix" date="2010-02-12">
197 Improved exception message if the extra field data in ZIP
198 archives cannot be parsed.
199 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000200 <action type="fix" date="2010-02-11" issue="COMPRESS-17">
201 Tar format unspecified - current support documented.
202 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000203 <action type="add" issue="COMPRESS-95" date="2010-01-29"
Christian Grobmeiere7517b82010-01-29 07:47:21 +0000204 due-to="Joerg Bellmann">
205 Improve ExceptionMessages in ArchiveStreamFactory
206 </action>
Stefan Bodewig5066e9a2010-01-07 09:34:55 +0000207 <action type="fix" issue="COMPRESS-94" date="2010-01-07"
208 due-to="Anon Devs">
209 ZipArchiveEntry's equals method was broken for entries created
210 with the String-arg constructor. This lead to broken ZIP
211 archives if two different entries had the same hash code.
212 </action>
Stefan Bodewigdc3fc472009-10-30 05:29:17 +0000213 <action type="fix" issue="COMPRESS-87" date="2009-10-30"
214 due-to="Antoni Mylka">
215 ZipArchiveInputStream could repeatedly return 0 on read() when
216 the archive was truncated.
217 </action>
Stefan Bodewig7bb5d882009-10-08 12:07:19 +0000218 <action type="fix" issue="COMPRESS-86" date="2009-10-08">
219 Tar archive entries holding the file name for names longer
220 than 100 characters in GNU longfile mode didn't properly
221 specify they'd be using the "oldgnu" extension.
222 </action>
Stefan Bodewig3e2ddad2009-08-25 08:11:44 +0000223 <action type="add" date="2009-08-25">
224 A new constructor of TarArchiveEntry can create entries with
225 names that start with slashes - the default is to strip
226 leading slashes in order to create relative path names.
227 </action>
Stefan Bodewig7be8ef62009-08-01 20:25:13 +0000228 <action issue="COMPRESS-83" type="fix" date="2009-08-01">
229 Delegate all read and write methods in GZip stream in order to
230 speed up operations.
231 </action>
232 <action type="add" date="2009-08-01">
233 ArchiveEntry now has a getLastModifiedDate method.
234 </action>
235 <action type="fix" date="2009-08-01">
236 The ar and cpio streams now properly read and write last
237 modified times.
238 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000239 <action issue="COMPRESS-81" type="fix" date="2009-06-30">
240 TarOutputStream can leave garbage at the end of the archive
241 </action>
Stefan Bodewig47b706e2009-06-30 08:23:08 +0000242 <action issue="COMPRESS-78" type="add" date="2009-06-30"
243 due-to="Jukka Zitting">
244 Add a BZip2Utils class modelled after GZipUtils
245 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000246 </release>
247 <release version="1.0" date="2009-05-21" description="First Public Release">
248 <action dev="all" type="add" date="2009-05-21">
Christian Grobmeier35ac05e2009-05-10 17:32:20 +0000249 Initial release
250 </action>
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +0000251 <action dev="sgoeschl" type="fix">
252 Updating the pom.xml for preparing a move to commons-proper
253 </action>
254 </release>
255 </body>
256</document>