blob: 04a3a5a90210d6dc1990eb5c6a0be6193d84a613 [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
251. Add items when you fix a bug or add a feature (this makes the
26release 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
37then tweak the formatting if necessary
38and commit
39
40The <action> type attribute can be add,update,fix,remove.
41-->
42
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +000043<document>
44 <properties>
45 <title>commons-compress</title>
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +000046 </properties>
47 <body>
Stefan Bodewig2318ba32009-06-30 07:25:44 +000048 <release version="1.1" date="as in SVN" description="Release 1.1">
Sebastian Bazley69f6d062010-05-05 10:59:58 +000049 <action type="update" date="2010-04-22" issue="COMPRESS-106">
50 Remove unnecessary method
51 ZipFile.OFFSET_COMPARATOR.new Comparator() {...}.equals(Object o)
52 </action>
53 <action type="update" date="2010-04-19" issue="COMPRESS-105">
54 Document that the name of an ZipArchiveEntry determines whether
55 an entry is considered a directory or not.
56 If you don't use the constructor with the File argument the entry's
57 name must end in a "/" in order for the entry to be known as a directory.
58 </action>
Stefan Bodewig03e94a42010-03-19 15:08:23 +000059 <action type="add" date="2010-03-19" issue="COMPRESS-103">
60 ZipArchiveInputStream can optionally extract data that used
61 the STORED compression method and a data descriptor.
62 Doing so in a stream is not safe in general, so you have to
63 explicitly enable the feature. By default the stream will
64 throw an exception if it encounters such an entry.
65 </action>
Stefan Bodewig62cb9c42010-03-12 16:06:20 +000066 <action type="fix" date="2010-03-12" issue="COMPRESS-100">
67 ZipArchiveInputStream will throw an exception if it detects an
68 entry that uses a data descriptor for a STORED entry since it
69 cannot reliably find the end of data for this "compression"
70 method.
71 </action>
Stefan Bodewigd7ea9ff2010-03-12 15:35:44 +000072 <action type="fix" date="2010-03-12" issue="COMPRESS-101">
73 ZipArchiveInputStream should now properly read archives that
74 use data descriptors but without the "unofficial" signature.
75 </action>
Stefan Bodewig30e1cc82010-03-09 11:23:41 +000076 <action type="add" date="2010-03-09" issue="COMPRESS-98">
77 The ZIP classes will throw specialized exceptions if any
78 attempt is made to read or write data that uses zip features
79 not supported (yet).
80 </action>
Stefan Bodewigade93792010-03-08 12:00:25 +000081 <action type="add" date="2010-03-08" issue="COMPRESS-99">
82 ZipFile#getEntries returns entries in a predictable order -
83 the order they appear inside the central directory.
84 A new method getEntriesInPhysicalOrder returns entries in
85 order of the entry data, i.e. the order ZipArchiveInputStream
86 would see.
87 </action>
Stefan Bodewige0ffbc12010-02-19 10:59:01 +000088 <action type="add" date="2010-02-19">
Stefan Bodewige0692ec2010-02-24 15:35:47 +000089 The Archive*Stream and ZipFile classes now have
90 can(Read|Write)EntryData methods that can be used to check
91 whether a given entry's data can be read/written.
Stefan Bodewiga33505b2010-02-19 12:23:27 +000092 The method currently returns false for ZIP archives if an
93 entry uses an unsupported compression method or encryption.
Stefan Bodewige0ffbc12010-02-19 10:59:01 +000094 </action>
95 <action type="add" date="2010-02-19" issue="COMPRESS-89">
96 The ZIP classes now detect encrypted entries.
97 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +000098 <action type="update" date="2010-02-18" issue="COMPRESS-79">
99 Move DOS/Java time conversions into Zip utility class.
100 </action>
Stefan Bodewiga1015f32010-02-18 16:11:13 +0000101 <action type="fix" date="2010-02-18" issue="COMPRESS-74">
102 ZipArchiveInputStream failed to update the number of bytes
103 read properly.
104 </action>
105 <action type="fix" date="2010-02-18">
106 ArchiveInputStream has a new method getBytesRead that should
107 be preferred over getCount since the later may truncate the
108 number of bytes read for big archives.
109 </action>
Stefan Bodewig315b9472010-02-18 14:56:03 +0000110 <action type="fix" date="2010-02-18" issue="COMPRESS-85">
111 The cpio archives created by CpioArchiveOutputStream couldn't
112 be read by many existing native implementations because the
113 archives contained multiple entries with the same inode/device
114 combinations and weren't padded to a blocksize of 512 bytes.
115 </action>
Stefan Bodewig91695e42010-02-16 13:59:03 +0000116 <action type="fix" date="2010-02-16" issue="COMPRESS-73">
117 ZipArchiveEntry, ZipFile and ZipArchiveInputStream are now
118 more lenient when parsing extra fields.
119 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000120 <action type="fix" date="2010-02-12" issue="COMPRESS-82">
121 cpio is terribly slow.
122 Documented that buffered streams are needed for performance
123 </action>
Stefan Bodewig292e1852010-03-04 15:54:09 +0000124 <action type="add" date="2010-02-12" issue="COMPRESS-97">
125 Added autodetection of compression format to
126 CompressorStreamFactory.
127 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000128 <action type="fix" date="2010-02-12">
129 Improved exception message if the extra field data in ZIP
130 archives cannot be parsed.
131 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000132 <action type="fix" date="2010-02-11" issue="COMPRESS-17">
133 Tar format unspecified - current support documented.
134 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000135 <action type="add" issue="COMPRESS-95" date="2010-01-29"
Christian Grobmeiere7517b82010-01-29 07:47:21 +0000136 due-to="Joerg Bellmann">
137 Improve ExceptionMessages in ArchiveStreamFactory
138 </action>
Stefan Bodewig5066e9a2010-01-07 09:34:55 +0000139 <action type="fix" issue="COMPRESS-94" date="2010-01-07"
140 due-to="Anon Devs">
141 ZipArchiveEntry's equals method was broken for entries created
142 with the String-arg constructor. This lead to broken ZIP
143 archives if two different entries had the same hash code.
144 </action>
Stefan Bodewigdc3fc472009-10-30 05:29:17 +0000145 <action type="fix" issue="COMPRESS-87" date="2009-10-30"
146 due-to="Antoni Mylka">
147 ZipArchiveInputStream could repeatedly return 0 on read() when
148 the archive was truncated.
149 </action>
Stefan Bodewig7bb5d882009-10-08 12:07:19 +0000150 <action type="fix" issue="COMPRESS-86" date="2009-10-08">
151 Tar archive entries holding the file name for names longer
152 than 100 characters in GNU longfile mode didn't properly
153 specify they'd be using the "oldgnu" extension.
154 </action>
Stefan Bodewig3e2ddad2009-08-25 08:11:44 +0000155 <action type="add" date="2009-08-25">
156 A new constructor of TarArchiveEntry can create entries with
157 names that start with slashes - the default is to strip
158 leading slashes in order to create relative path names.
159 </action>
Stefan Bodewig7be8ef62009-08-01 20:25:13 +0000160 <action issue="COMPRESS-83" type="fix" date="2009-08-01">
161 Delegate all read and write methods in GZip stream in order to
162 speed up operations.
163 </action>
164 <action type="add" date="2009-08-01">
165 ArchiveEntry now has a getLastModifiedDate method.
166 </action>
167 <action type="fix" date="2009-08-01">
168 The ar and cpio streams now properly read and write last
169 modified times.
170 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000171 <action issue="COMPRESS-81" type="fix" date="2009-06-30">
172 TarOutputStream can leave garbage at the end of the archive
173 </action>
Stefan Bodewig47b706e2009-06-30 08:23:08 +0000174 <action issue="COMPRESS-78" type="add" date="2009-06-30"
175 due-to="Jukka Zitting">
176 Add a BZip2Utils class modelled after GZipUtils
177 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000178 </release>
179 <release version="1.0" date="2009-05-21" description="First Public Release">
180 <action dev="all" type="add" date="2009-05-21">
Christian Grobmeier35ac05e2009-05-10 17:32:20 +0000181 Initial release
182 </action>
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +0000183 <action dev="sgoeschl" type="fix">
184 Updating the pom.xml for preparing a move to commons-proper
185 </action>
186 </release>
187 </body>
188</document>