svn commit: r1738476 - /maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageMojo.java

[hb...@apache.org]

Author: hboutemy
Date: Sun Apr 10 22:20:34 2016
New Revision: 1738476

URL: http://svn.apache.org/viewvc?rev=1738476&view=rev
Log:
[MSITE-688] enhanced site:stage documentation

Modified:
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageMojo.java

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageMojo.java?rev=1738476&r1=1738475&r2=1738476&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageMojo.java Sun Apr 10 22:20:34 2016
@@ -33,10 +33,11 @@ import org.apache.maven.project.MavenPro
  * Deploys the generated site to a local staging or mock directory based on the site URL
  * specified in the <code>&lt;distributionManagement&gt;</code> section of the
  * POM.
- * <p>
- * It can be used to test that links between module sites in a multi-module
+ * <p>It can be used to test that links between module sites in a multi-module
  * build work.
  * </p>
+ * <p>This goal requires the site to already have been generated using the site goal,
+ * such as by calling <code>mvn site</code></p>
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @version $Id$