commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r927486 - /commons/proper/net/branches/NET_2_0/src/changes/changes.xml
Date Thu, 25 Mar 2010 16:32:16 GMT
Author: sebb
Date: Thu Mar 25 16:32:16 2010
New Revision: 927486

URL: http://svn.apache.org/viewvc?rev=927486&view=rev
Log:
Start documenting API changes

Modified:
    commons/proper/net/branches/NET_2_0/src/changes/changes.xml

Modified: commons/proper/net/branches/NET_2_0/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/net/branches/NET_2_0/src/changes/changes.xml?rev=927486&r1=927485&r2=927486&view=diff
==============================================================================
--- commons/proper/net/branches/NET_2_0/src/changes/changes.xml (original)
+++ commons/proper/net/branches/NET_2_0/src/changes/changes.xml Thu Mar 25 16:32:16 2010
@@ -15,15 +15,56 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 See the License for the 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>Changes</title>
         <author email="rwinston@apache.org">Rory Winston</author>
     </properties>
 
+    <!-- NOTE: 
+    The description below is specially formatted so as to improve the layout of the generated
release notes:
+    The parsing process removes all line feeds, replacing them with a single space.
+    The Velocity template in resources/templates has been enhanced to replace pairs of adjacent
spaces
+    with a new-line in the release notes. (These spaces are ignored when displaying HTML).
+    If the output is not quite correct, check for invisible trailing spaces!
+     -->
 
     <body>
-        <release version="2.1" date="" description="Fix release">
+        <release version="2.1" date="" description="
+This is primarily a maintenance release, but it also includes new features and enhancements.
+
+  Users of version 2.0 are encouraged to upgrade to 2.1, as this release includes some important
bug fixes.
+
+  See the detailed list of changes below for full description of all bug fixes and enhancements.
+
+  This release contains some API compatibility breaks with version 2.0 (see also the clirr
report):
+  Removed 4 unused fields from oacn.ftp.FTPSClient: KEYSTORE_ALGORITHM, PROVIDER, STORE_TYPE,
TRUSTSTORE_ALGORITHM
+  Removed the field constant CODE_408 from org.apache.commons.net.nntp.NNTPReply
+  
+  TO BE COMPLETED
+">
             <action dev="sebb" type="remove">
                 Removed the following unused fields from org.apache.commons.net.ftp.FTPSClient:
                 KEYSTORE_ALGORITHM, PROVIDER, STORE_TYPE, TRUSTSTORE_ALGORITHM



Mime
View raw message