svn commit: r1738477 - in /maven/plugins/trunk/maven-site-plugin/src: main/java/org/apache/maven/plugins/site/deploy/SiteStageMojo.java site/apt/index.apt.vm

[hb...@apache.org]

Author: hboutemy
Date: Sun Apr 10 22:35:08 2016
New Revision: 1738477

URL: http://svn.apache.org/viewvc?rev=1738477&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
    maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt.vm

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=1738477&r1=1738476&r2=1738477&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:35:08 2016
@@ -37,7 +37,7 @@ import org.apache.maven.project.MavenPro
  * 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>
+ * such as by calling <code>mvn site</code>.</p>
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @version $Id$

Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt.vm?rev=1738477&r1=1738476&r2=1738477&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt.vm (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt.vm Sun Apr 10 22:35:08 2016
@@ -53,7 +53,8 @@ ${project.name}
 
    * {{{./stage-mojo.html}site:stage}} generates a site in a local staging or mock directory based on the site URL
      specified in the <<<\<distributionManagement\>>>> section of the POM. It can be used
-     to test that links between module sites in a multi module build works.
+     to test that links between module sites in a multi module build work. This goal requires the site to already have been
+     generated using the site goal, such as by calling <<<mvn site>>>.
 
    * {{{./stage-deploy-mojo.html}site:stage-deploy}} deploys the generated site to a staging or mock directory to the site
      URL specified in the <<<\<distributionManagement\>>>> section of the POM.