You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by sd...@apache.org on 2016/07/22 07:01:10 UTC

[42/50] commons-crypto git commit: Docn

Docn

Project: http://git-wip-us.apache.org/repos/asf/commons-crypto/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-crypto/commit/5e5cf6d3
Tree: http://git-wip-us.apache.org/repos/asf/commons-crypto/tree/5e5cf6d3
Diff: http://git-wip-us.apache.org/repos/asf/commons-crypto/diff/5e5cf6d3

Branch: refs/heads/CRYPTO-1.0.0
Commit: 5e5cf6d3096b4ebee59b658bcd20fdd835718d78
Parents: c22d723
Author: Sebb <se...@apache.org>
Authored: Wed Jul 13 10:15:47 2016 +0100
Committer: Sebb <se...@apache.org>
Committed: Wed Jul 13 10:15:47 2016 +0100

----------------------------------------------------------------------
 src/changes/changes.xml | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/5e5cf6d3/src/changes/changes.xml
----------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index d6d41ca..5ded7b0 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -29,14 +29,37 @@
   SVN commits. Set the project.properties' maven.changelog.range
   property to the number of days since the last release.
 
+  To generate the release notes from this file:
+  
+  mvn changes:announcement-generate -Prelease-notes [-Dchanges.version=nnn]
+  
+  then tweak the formatting if necessary
+  and commit
 
   The <action> type attribute can be add,update,fix,remove.
 -->
 
 <document>
   <properties>
-    <title>Release Notes</title>
+    <title>Changes</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 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!
+
+  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="1.0.0" date="2016-06-06" description="Feature and bug fix release">
       <action issue="CRYPTO-68" type="add" dev="britter" >Enable common code quality reports.</action>