svn commit: r1457384 - /commons/cms-site/trunk/content/xdoc/releases/prepare.xml

[bo...@apache.org]

Author: bodewig
Date: Sun Mar 17 06:24:55 2013
New Revision: 1457384

URL: http://svn.apache.org/r1457384
Log:
som clarifications around RELEASE-NOTES/changes

Modified:
    commons/cms-site/trunk/content/xdoc/releases/prepare.xml

Modified: commons/cms-site/trunk/content/xdoc/releases/prepare.xml
URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/releases/prepare.xml?rev=1457384&r1=1457383&r2=1457384&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/releases/prepare.xml (original)
+++ commons/cms-site/trunk/content/xdoc/releases/prepare.xml Sun Mar 17 06:24:55 2013
@@ -261,23 +261,25 @@
 	<pre>
     mvn changes:announcement-generate
     mv target/announcement/foo-release-notes.vm RELEASE-NOTES.txt </pre></p>
-    <p>
-    For this to work, the following properties need to be included in the <code>configuration</code>
+    <p>The commons parent project ships with a
+    <a href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/trunk/src/changes/release-notes.vm">default
+    template</a>.  If you want to configure your own you need to set
+    the following property in the <code>configuration</code>
     for the maven-changes-plugin in the pom:
     <pre>
     &lt;template&gt;foo-release-notes.vm&lt;/template&gt;
-    &lt;templateDirectory&gt;templates&lt;/templateDirectory&gt; </pre> </p>
-    <p>
+    </pre>
     and the Velocity template, <code>foo-release-notes.vm</code> needs to be defined in
-    <code>src/main/resources/templates.</code></p>
+    <code>src/changes</code>.  If you want to put it into a different directory
+        you also want to set the <code>templateDirectory</code> property.</p>
 		<p>
 	The release notes should be a plain text file. Take care to ensure
 	that the format allows easy reading on a wide variety of platforms.
 	Long lines may need to be broken manually to allow them to be easily
 	read easily without word wrap.		
 		</p>
-   <!-- TODO: consider dropping the remainder of this subsection.  Does anybody actually do 
-      the svn log analysis? -->
+  </subsection>
+  <subsection name='Checking the commit log'>
 	<p>
         Different components have their own ways of creating the change log. 
         The most common, and recommended, way, is to record all significant
@@ -415,6 +417,7 @@
 	This product includes software developed by
 	The Apache Software Foundation (http://www.apache.org/).
         </pre>
+      <p>Verify <code>{latest}</code> is the current year</p>
         <p>
         The NOTICE.txt must be distributed along with the LICENSE.txt.
         Check that the distribution build correctly adds this file