commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1572145 - /commons/proper/dbcp/trunk/src/changes/changes.xml
Date Wed, 26 Feb 2014 16:27:19 GMT
Author: sebb
Date: Wed Feb 26 16:27:19 2014
New Revision: 1572145

URL: http://svn.apache.org/r1572145
Log:
Tweak description formatting to generate better spacing in Release Notes

Modified:
    commons/proper/dbcp/trunk/src/changes/changes.xml

Modified: commons/proper/dbcp/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/changes/changes.xml?rev=1572145&r1=1572144&r2=1572145&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/changes/changes.xml (original)
+++ commons/proper/dbcp/trunk/src/changes/changes.xml Wed Feb 26 16:27:19 2014
@@ -43,12 +43,30 @@ The <action> type attribute can be add,u
   <properties>
     <title>Commons DBCP Release Notes</title>
   </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 src/changes 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!
+
+    N.B. The release notes template groups actions by type, and only extracts data for the
current release.
+    The changes report outputs actions in the order they appear in this file.
+
+    To regenerate the release notes:
+    mvn changes:announcement-generate -Prelease-notes [-Dchanges.version=nnn]
+
+    Defining changes.version allows one to create the RN without first removing the SNAPSHOT
suffix.
+     -->
+
   <body>
-    <release version="2.0" date="TBD" description="This release includes new
-     features as well as bug fixes and enhancements. Version 2.0.x supports JDBC
-     4.1, so requires Java 7.  Java 6 users should use DBCP 1.4.x which supports
-     JDBC 4. Java 1.4 and Java 5 users should use DBCP 1.3.x which supports JDBC
-     3. Applications running under Java 7 should use DBCP 2.0.x.">
+    <release version="2.0" date="TBD" description=
+"This release includes new features as well as bug fixes and enhancements.
+ Version 2.0.x supports JDBC 4.1, so requires Java 7.
+ Java 6 users should use DBCP 1.4.x which supports JDBC 4.
+ Java 1.4 and Java 5 users should use DBCP 1.3.x which supports JDBC 3.
+ Applications running under Java 7 should use DBCP 2.0.x.
+      ">
       <action issue="DBCP-411" dev="sebb" type="fix">
         BasicManagedDataSource - unregister from JMX on close().
       </action>



Mime
View raw message