svn commit: r1001691 - /maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/

[br...@apache.org]

Author: brett
Date: Mon Sep 27 12:04:15 2010
New Revision: 1001691

URL: http://svn.apache.org/viewvc?rev=1001691&view=rev
Log:
[MRELEASE-563] improve descriptions of mojos for output in the release:help goal (and help plugin equivalent)

Modified:
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/CleanReleaseMojo.java
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareWithPomReleaseMojo.java
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/UpdateVersionsMojo.java

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java?rev=1001691&r1=1001690&r2=1001691&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java Mon Sep 27 12:04:15 2010
@@ -26,8 +26,8 @@ import org.apache.maven.shared.release.R
 import org.apache.maven.shared.release.config.ReleaseDescriptor;
 
 /**
- * Branch a project in SCM.
- * For more info see <a href="/plugins/maven-release-plugin/examples/branch.html">this example</a>.
+ * Branch a project in SCM, using the same steps as the <tt>release:prepare</tt> goal, creating a branch instead of a tag.
+ * For more info see <a href="http://maven.apache.org/plugins/maven-release-plugin/examples/branch.html">http://maven.apache.org/plugins/maven-release-plugin/examples/branch.html</a>.
  *
  * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
  * @version $Id$

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/CleanReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/CleanReleaseMojo.java?rev=1001691&r1=1001690&r2=1001691&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/CleanReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/CleanReleaseMojo.java Mon Sep 27 12:04:15 2010
@@ -24,8 +24,10 @@ import org.apache.maven.plugin.MojoFailu
 import org.apache.maven.shared.release.config.ReleaseDescriptor;
 
 /**
- * Clean up after a release preparation.
- * For more info see <a href="/plugins/maven-release-plugin/examples/clean-release.html">this example</a>.
+ * Clean up after a release preparation. This is done automatically after a successful <tt>release:perform</tt>,
+ * so is best served for cleaning up a failed or abandoned release, or a dry run. Note that only the working copy
+ * is cleaned up, no previous steps are rolled back.
+ * For more info see <a href="http://maven.apache.org/plugins/maven-release-plugin/examples/clean-release.html">http://maven.apache.org/plugins/maven-release-plugin/examples/clean-release.html</a>.
  *
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  * @version $Id$

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java?rev=1001691&r1=1001690&r2=1001691&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java Mon Sep 27 12:04:15 2010
@@ -29,8 +29,9 @@ import org.apache.maven.shared.release.c
 import org.codehaus.plexus.util.StringUtils;
 
 /**
- * Perform a release from SCM.
- * For more info see <a href="/plugins/maven-release-plugin/examples/perform-release.html">this example</a>.
+ * Perform a release from SCM, either from a specified tag, or the tag representing the previous release in
+ * the working copy created by <tt>release:prepare</tt>.
+ * For more info see <a href="http://maven.apache.org/plugins/maven-release-plugin/examples/perform-release.html">http://maven.apache.org/plugins/maven-release-plugin/examples/perform-release.html</a>.
  *
  * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java?rev=1001691&r1=1001690&r2=1001691&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java Mon Sep 27 12:04:15 2010
@@ -28,8 +28,10 @@ import org.apache.maven.shared.release.c
 import org.apache.maven.shared.release.config.ReleaseUtils;
 
 /**
- * Prepare for a release in SCM.
- * For more info see <a href="/plugins/maven-release-plugin/examples/prepare-release.html">this example</a>.
+ * Prepare for a release in SCM. Steps through several phases to ensure the POM is ready to be
+ * released and then prepares SCM to eventually contain a tagged version of the release and a record
+ * in the local copy of the parameters used. This can be followed by a call to <tt>release:perform</tt>.
+ * For more info see <a href="http://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html">http://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html</a>.
  *
  * @author <a href="mailto:jdcasey@apache.org">John Casey</a>
  * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareWithPomReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareWithPomReleaseMojo.java?rev=1001691&r1=1001690&r2=1001691&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareWithPomReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareWithPomReleaseMojo.java Mon Sep 27 12:04:15 2010
@@ -24,7 +24,6 @@ import org.apache.maven.plugin.MojoFailu
 
 /**
  * Prepare for a release in SCM, fully resolving dependencies for the purpose of producing a "release POM".
- * For more info see <a href="/plugins/maven-release-plugin/examples/prepare-release.html">this example</a>.
  *
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  * @aggregator

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java?rev=1001691&r1=1001690&r2=1001691&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java Mon Sep 27 12:04:15 2010
@@ -26,8 +26,9 @@ import org.apache.maven.shared.release.R
 import org.apache.maven.shared.release.config.ReleaseDescriptor;
 
 /**
- * Rollback changes made by a previous release.
- * For more info see <a href="/plugins/maven-release-plugin/examples/rollback-release.html">this example</a>.
+ * Rollback changes made by a previous release. This requires that the previous release descriptor <tt>release.properties</tt>
+ * is still available in the local working copy.
+ * For more info see <a href="http://maven.apache.org/plugins/maven-release-plugin/examples/rollback-release.html">http://maven.apache.org/plugins/maven-release-plugin/examples/rollback-release.html</a>.
  *
  * @aggregator
  * @goal rollback

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/UpdateVersionsMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/UpdateVersionsMojo.java?rev=1001691&r1=1001690&r2=1001691&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/UpdateVersionsMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/UpdateVersionsMojo.java Mon Sep 27 12:04:15 2010
@@ -32,8 +32,9 @@ import org.apache.maven.shared.release.c
 import org.apache.maven.shared.release.config.ReleaseUtils;
 
 /**
- * Update the POM versions for a project.
- * For more info see <a href="/plugins/maven-release-plugin/examples/update-versions.html">this example</a>.
+ * Update the POM versions for a project. This performs the normal version updates of the <tt>release:prepare</tt>
+ * goal without making other modifications to the SCM such as tagging.
+ * For more info see <a href="http://maven.apache.org/plugins/maven-release-plugin/examples/update-versions.html">http://maven.apache.org/plugins/maven-release-plugin/examples/update-versions.html</a>.
  *
  * @author Paul Gier
  * @version $Id$