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