Author: sebb
Date: Sun Jan 18 21:46:41 2015
New Revision: 1652860
URL: http://svn.apache.org/r1652860
Log:
General tweaks
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=1652860&r1=1652859&r2=1652860&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/releases/prepare.xml (original)
+++ commons/cms-site/trunk/content/xdoc/releases/prepare.xml Sun Jan 18
21:46:41 2015
@@ -67,6 +67,9 @@
Typically, the proposer volunteers as the release manager and it passes
by
<a
href='http://www.apache.org/foundation/glossary.html#LazyConsensus'>lazy
consensus</a>.
</p>
+ </subsection>
+
+ <subsection name='Update KEYS file if necessary'>
<p>
If the release manager has not yet performed a Commons release, they may
need to add their
public key to the Commons KEYS file, which is located at:
@@ -82,6 +85,9 @@
The public key should also be
<a
href="http://www.apache.org/dev/release-signing.html#keyserver-upload";>uploaded
to a public keyserver</a>.
</p>
+ </subsection>
+
+ <subsection name='Create a Release Plan'>
<p>
A release plan should also be prepared, in which the tasks remaining to
be done before
the release are listed. It may be useful to prepare draft release notes
before proposing
@@ -147,6 +153,25 @@
Check that the Javadocs have the correct version number.
</p>
<p>
+ If the code is targetted at Java 7 or before, check that the Javadoc can
still be created using Javadoc 8.
+ Javadoc 8 is a lot stricter about the syntax. Ideally fix all the syntax
errors. However if this is not
+ feasible in the time-scale, consider adding a temporary profile to the pom
to disable the stricter checking:
+ <code>
+ <profile>
+ <!-- Temporary hack to suppress Javadoc 8 errors -->
+ <!-- to re-enable the checks, build with -P-javadoc_8 -->
+ <id>javadoc_8</id>
+ <activation>
+ <jdk>[1.8,)</jdk>
+ </activation>
+ <properties>
+ <!-- Disable Xdoclint, until JavaDoc issues are fixed -->
+ <additionalparam>-Xdoclint:none</additionalparam>
+ </properties>
+ </profile>
+ </code>
+ </p>
+ <p>
If the component uses checkstyle, findbugs or PMD tools, examine the
reports and fix all
problems.
</p>
