Mailing-List: contact commits-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@commons.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r933780 - in /commons/proper/compress/trunk:
 RELEASE-NOTES.txt
 pom.xml src/changes/changes.xml src/changes/release-notes.vm
Date: Tue, 13 Apr 2010 21:02:37 -0000
To: commits@commons.apache.org
From: sebb@apache.org
Message-Id: <20100413210237.B65012388A02@eris.apache.org>

Author: sebb
Date: Tue Apr 13 21:02:37 2010
New Revision: 933780

URL: http://svn.apache.org/viewvc?rev=933780&view=rev
Log:
Add release-notes.vm for generating RELEASE-NOTES.txt

Added:
    commons/proper/compress/trunk/RELEASE-NOTES.txt   (with props)
    commons/proper/compress/trunk/src/changes/release-notes.vm   (with props)
Modified:
    commons/proper/compress/trunk/pom.xml
    commons/proper/compress/trunk/src/changes/changes.xml

Added: commons/proper/compress/trunk/RELEASE-NOTES.txt
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/RELEASE-NOTES.txt?rev=933780&view=auto
==============================================================================
--- commons/proper/compress/trunk/RELEASE-NOTES.txt (added)
+++ commons/proper/compress/trunk/RELEASE-NOTES.txt Tue Apr 13 21:02:37 2010
@@ -0,0 +1,79 @@
+                        
+
+              Apache Commons Compress 1.1-SNAPSHOT RELEASE NOTES
+
+Release 1.1
+
+Changes in this version include:
+
+New features:
+o COMPRESS-103:  ZipArchiveInputStream can optionally extract data that used
+        the STORED compression method and a data descriptor.
+        Doing so in a stream is not safe in general, so you have to
+        explicitly enable the feature.  By default the stream will
+        throw an exception if it encounters such an entry. 
+o COMPRESS-98:  The ZIP classes will throw specialized exceptions if any
+        attempt is made to read or write data that uses zip features
+        not supported (yet). 
+o COMPRESS-99:  ZipFile#getEntries returns entries in a predictable order -
+        the order they appear inside the central directory.
+        A new method getEntriesInPhysicalOrder returns entries in
+        order of the entry data, i.e. the order ZipArchiveInputStream
+        would see. 
+o The Archive*Stream and ZipFile classes now have
+        can(Read|Write)EntryData methods that can be used to check
+        whether a given entry's data can be read/written.
+        The method currently returns false for ZIP archives if an
+        entry uses an unsupported compression method or encryption. 
+o COMPRESS-89:  The ZIP classes now detect encrypted entries. 
+o COMPRESS-97:  Added autodetection of compression format to
+        CompressorStreamFactory. 
+o COMPRESS-95:  Improve ExceptionMessages in ArchiveStreamFactory Thanks to Joerg Bellmann. 
+o A new constructor of TarArchiveEntry can create entries with
+        names that start with slashes - the default is to strip
+        leading slashes in order to create relative path names. 
+o ArchiveEntry now has a getLastModifiedDate method. 
+o COMPRESS-78:  Add a BZip2Utils class modelled after GZipUtils Thanks to Jukka Zitting. 
+
+Fixed Bugs:
+o COMPRESS-100:  ZipArchiveInputStream will throw an exception if it detects an
+        entry that uses a data descriptor for a STORED entry since it
+        cannot reliably find the end of data for this "compression"
+        method. 
+o COMPRESS-101:  ZipArchiveInputStream should now properly read archives that
+        use data descriptors but without the "unofficial" signature. 
+o COMPRESS-74:  ZipArchiveInputStream failed to update the number of bytes
+        read properly. 
+o ArchiveInputStream has a new method getBytesRead that should
+        be preferred over getCount since the later may truncate the
+        number of bytes read for big archives. 
+o COMPRESS-85:  The cpio archives created by CpioArchiveOutputStream couldn't
+        be read by many existing native implementations because the
+        archives contained multiple entries with the same inode/device
+        combinations and weren't padded to a blocksize of 512 bytes. 
+o COMPRESS-73:  ZipArchiveEntry, ZipFile and ZipArchiveInputStream are now
+        more lenient when parsing extra fields. 
+o Improved exception message if the extra field data in ZIP
+        archives cannot be parsed. 
+o COMPRESS-94:  ZipArchiveEntry's equals method was broken for entries created
+        with the String-arg constructor.  This lead to broken ZIP
+        archives if two different entries had the same hash code. Thanks to Anon Devs. 
+o COMPRESS-87:  ZipArchiveInputStream could repeatedly return 0 on read() when
+        the archive was truncated. Thanks to Antoni Mylka. 
+o COMPRESS-86:  Tar archive entries holding the file name for names longer
+        than 100 characters in GNU longfile mode didn't properly
+        specify they'd be using the "oldgnu" extension. 
+o COMPRESS-83:  Delegate all read and write methods in GZip stream in order to
+        speed up operations. 
+o The ar and cpio streams now properly read and write last
+        modified times. 
+o COMPRESS-81:  TarOutputStream can leave garbage at the end of the archive 
+
+
+ 
+For complete information on Commons Compress, including instructions on how to submit bug reports,
+patches, or suggestions for improvement, see the Apache Commons Compress website:
+
+http://commons.apache.org/compress/
+
+

Propchange: commons/proper/compress/trunk/RELEASE-NOTES.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: commons/proper/compress/trunk/pom.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/pom.xml?rev=933780&r1=933779&r2=933780&view=diff
==============================================================================
--- commons/proper/compress/trunk/pom.xml (original)
+++ commons/proper/compress/trunk/pom.xml Tue Apr 13 21:02:37 2010
@@ -131,6 +131,19 @@
           </archive>
         </configuration>
       </plugin>
+      <!-- Repeat the configuration here for use when directly invoking the plugin -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-changes-plugin</artifactId>
+        <version>2.3</version>
+        <configuration>
+          <issueLinkTemplatePerSystem>
+            <default>%URL%/%ISSUE%</default>
+          </issueLinkTemplatePerSystem>
+          <template>release-notes.vm</template>
+          <templateDirectory>src/changes</templateDirectory>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 
@@ -140,14 +153,19 @@
         <!-- generate the changes report from changes.xml and link to JIRA -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-changes-plugin</artifactId>
-        <version>2.0</version>
+        <version>2.3</version>
         <configuration>
-          <issueLinkTemplate>%URL%/%ISSUE%</issueLinkTemplate>
+           <issueLinkTemplatePerSystem>
+               <default>%URL%/%ISSUE%</default>
+           </issueLinkTemplatePerSystem>
+           <template>release-notes.vm</template>
+           <templateDirectory>src/changes</templateDirectory>
         </configuration>
         <reportSets>
           <reportSet>
             <reports>
               <report>changes-report</report>
+              <report>jira-report</report>
             </reports>
           </reportSet>
         </reportSets>

Modified: commons/proper/compress/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/changes/changes.xml?rev=933780&r1=933779&r2=933780&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/changes/changes.xml (original)
+++ commons/proper/compress/trunk/src/changes/changes.xml Tue Apr 13 21:02:37 2010
@@ -17,6 +17,29 @@
  specific language governing permissions and limitations
  under the License.
 -->
+
+<!--
+This file is also used by the maven-changes-plugin to generate the release notes.
+Useful ways of finding items to add to this file are:
+
+1.  Add items when you fix a bug or add a feature (this makes the 
+release process easy :-).
+
+2.  Do a JIRA search for tickets closed since the previous release.
+
+3.  Use the report generated by the maven-changelog-plugin to see all
+SVN commits. TBA how to use this with SVN.
+
+To generate the release notes from this file:
+
+mvn changes:announcement-generate
+mv target/announcement/release-notes.vm RELEASE-NOTES.txt
+then tweak the formatting if necessary 
+and commit
+
+The <action> type attribute can be add,update,fix,remove.
+-->
+
 <document>
   <properties>
     <title>commons-compress</title>

Added: commons/proper/compress/trunk/src/changes/release-notes.vm
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/changes/release-notes.vm?rev=933780&view=auto
==============================================================================
--- commons/proper/compress/trunk/src/changes/release-notes.vm (added)
+++ commons/proper/compress/trunk/src/changes/release-notes.vm Tue Apr 13 21:02:37 2010
@@ -0,0 +1,121 @@
+## Licensed to the Apache Software Foundation (ASF) under one
+## or more contributor license agreements.  See the NOTICE file
+## distributed with this work for additional information
+## regarding copyright ownership.  The ASF licenses this file
+## to you under the Apache License, Version 2.0 (the
+## "License"); you may not use this file except in compliance
+## with the License.  You may obtain a copy of the License at
+##
+##  http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing,
+## software distributed under the License is distributed on an
+## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+## KIND, either express or implied.  See the License for the
+## specific language governing permissions and limitations
+## under the License.
+                        
+
+              Apache ${project.name} ${version} RELEASE NOTES
+
+## Hack to improve layout: replace all pairs of spaces with a single new-line
+$release.description.replaceAll("  ", "
+")
+
+#if ($release.getActions().size() == 0)
+No changes defined in this version.
+#else
+Changes in this version include:
+
+#if ($release.getActions('add').size() !=0)
+New features:
+#foreach($actionItem in $release.getActions('add'))
+#set($action=$actionItem.getAction())
+#if ($actionItem.getIssue())
+#set($issue=$actionItem.getIssue())
+#else
+#set($issue="")
+#end
+#if ($actionItem.getDueTo())
+#set($dueto=$actionItem.getDueTo())
+#else
+#set($dueto="")
+#end
+o#if($!issue != "") $issue: #end ${action} #if($!dueto != "")Thanks to $dueto. #end
+
+#set($issue="")
+#set($dueto="")
+#end 
+#end
+
+#if ($release.getActions('fix').size() !=0)
+Fixed Bugs:
+#foreach($actionItem in $release.getActions('fix'))
+#set($action=$actionItem.getAction())
+#if ($actionItem.getIssue())
+#set($issue=$actionItem.getIssue())
+#else
+#set($issue="")
+#end
+#if ($actionItem.getDueTo())
+#set($dueto=$actionItem.getDueTo())
+#else
+#set($dueto="")
+#end
+o#if($!issue != "") $issue: #end ${action} #if($!dueto != "")Thanks to $dueto. #end
+
+#set($issue="")
+#set($dueto="")
+#end
+#end
+
+#if ($release.getActions('update').size() !=0)
+Changes:
+#foreach($actionItem in $release.getActions('update'))
+#set($action=$actionItem.getAction())
+#if ($actionItem.getIssue())
+#set($issue=$actionItem.getIssue())
+#else
+#set($issue="")
+#end
+#if ($actionItem.getDueTo())
+#set($dueto=$actionItem.getDueTo())
+#else
+#set($dueto="")
+#end
+o#if($!issue != "") $issue: #end ${action} #if($!dueto != "")Thanks to $dueto. #end
+
+#set($issue="")
+#set($dueto="")
+#end
+#end
+
+#if ($release.getActions('remove').size() !=0)
+Removed:
+#foreach($actionItem in $release.getActions('remove'))
+#set($action=$actionItem.getAction())
+#if ($actionItem.getIssue())
+#set($issue=$actionItem.getIssue())
+#else
+#set($issue="")
+#end
+#if ($actionItem.getDueTo())
+#set($dueto=$actionItem.getDueTo())
+#else
+#set($dueto="")
+#end
+o#if($!issue != "") $issue. #end ${action} #if($!dueto != "")Thanks to $dueto. #end
+
+#set($issue="")
+#set($dueto="")
+#end
+#end
+## End of main loop
+#end
+ 
+For complete information on ${project.name}, including instructions on how to submit bug reports,
+patches, or suggestions for improvement, see the Apache ${project.name} website:
+
+${project.url}
+
+

Propchange: commons/proper/compress/trunk/src/changes/release-notes.vm
------------------------------------------------------------------------------
    svn:eol-style = native