Author: dennisl
Date: Sun Mar 8 13:27:17 2009
New Revision: 751418
URL: http://svn.apache.org/viewvc?rev=751418&view=rev
Log:
o Sync and improve the documentation of goals.
Modified:
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteJarMojo.java
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageDeployMojo.java
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java
maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt
Modified:
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java?rev=751418&r1=751417&r2=751418&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java
Sun Mar 8 13:27:17 2009
@@ -59,7 +59,7 @@
/**
* Deploys the generated site using <code>scp</code> or <code>file</code>
- * protocol to the site specified in the
+ * protocol to the site URL specified in the
* <code><distributionManagement></code> section of the POM.
* <p>
* For <code>scp</code> protocol, the website files are packaged into zip
archive,
Modified:
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java?rev=751418&r1=751417&r2=751418&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java
Sun Mar 8 13:27:17 2009
@@ -39,7 +39,7 @@
import java.util.Map;
/**
- * Adds the site descriptor to the list of files to be installed/deployed.
+ * Adds the site descriptor (<code>site.xml</code>) to the list of files to be
installed/deployed.
*
* @author <a href="mailto:br...@apache.org";>Brett Porter</a>
* @version $Id$
Modified:
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteJarMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteJarMojo.java?rev=751418&r1=751417&r2=751418&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteJarMojo.java
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteJarMojo.java
Sun Mar 8 13:27:17 2009
@@ -29,7 +29,7 @@
import java.io.IOException;
/**
- * Bundles the site output into a jar so that it can be deployed to a
repository.
+ * Bundles the site output into a JAR so that it can be deployed to a
repository.
*
* @author <a href="mailto:mbeer...@yahoo.com";>Matthew Beermann</a>
* @version $Id$
Modified:
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageDeployMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageDeployMojo.java?rev=751418&r1=751417&r2=751418&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageDeployMojo.java
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageDeployMojo.java
Sun Mar 8 13:27:17 2009
@@ -45,9 +45,9 @@
import java.util.List;
/**
- * Deploys the generated site to a staging or mock directory on the site
+ * Deploys the generated site to a staging or mock directory to the site URL
* specified in the <code><distributionManagement></code> section of the
- * POM. It also supports <code>scp</code> and <code>file</code> protocols for
+ * POM. It supports <code>scp</code> and <code>file</code> protocols for
* deployment.
*
* @author <a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a>
Modified:
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java?rev=751418&r1=751417&r2=751418&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteStageMojo.java
Sun Mar 8 13:27:17 2009
@@ -32,7 +32,7 @@
import java.util.List;
/**
- * Generates a site in a local staging or mock directory based on the site url
+ * Generates a site in a local staging or mock directory based on the site URL
* specified in the <code><distributionManagement></code> section of the
* POM.
* <p>
@@ -53,7 +53,7 @@
/**
* Staging directory location. This needs to be an absolute path, like
* <code>C:\stagingArea\myProject\</code> on Windows or
- * <code>/stagingArea/myProject/</code> on Unix.
+ * <code>/stagingArea/myProject/</code> on Unix.
*
* @parameter expression="${stagingDirectory}"
*/
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt?rev=751418&r1=751417&r2=751418&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt Sun Mar 8
13:27:17 2009
@@ -3,7 +3,7 @@
------
Maria Odea Ching
------
- January 2008
+ 2009-03-08
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -39,24 +39,25 @@
* {{{site-mojo.html}site:site}} is used generate a site for a single
project.
Note that links between module sites in a multi module build will <<not>>
work.
- * {{{deploy-mojo.html}site:deploy}} is used to deploy the generated site
using <<<scp>>> or <<<file>>> protocol to the site
- specified in the <<<\<distributionManagement\>>>> section of the POM.
+ * {{{deploy-mojo.html}site:deploy}} is used to deploy the generated site
using <<<scp>>> or <<<file>>> protocol to
+ the site URL specified in the <<<\<distributionManagement\>>>> section of
the POM.
* {{{run-mojo.html}site:run}} starts the site up, rendering documents as
requested for faster editing. It uses Jetty
as the web server.
- * {{{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
+ * {{{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.
- * {{{stage-deploy-mojo.html}site:stage-deploy}} deploys the generated site
to a staging or mock directory on the site
- specified in the <<<\<distributionManagement\>>>> section of the POM. It
also supports <<<scp>>> and <<<file>>> protocols for deployment.
+ * {{{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.
It supports <<<scp>>> and <<<file>>>
+ protocols for deployment.
- * {{{attach-descriptor-mojo.html}site:attach-descriptor}} adds the site
descriptor to the list of files to be
- installed/deployed. For more references of the site descriptor,
+ * {{{attach-descriptor-mojo.html}site:attach-descriptor}} adds the site
descriptor (<<<site.xml>>>) to the list of
+ files to be installed/deployed. For more references of the site
descriptor,
{{{examples/sitedescriptor.html}here's a link}}.
- * {{{jar-mojo.html}site:jar}} is used to bundle the site output into a jar.
+ * {{{jar-mojo.html}site:jar}} bundles the site output into a JAR so that it
can be deployed to a repository.
* Usage
@@ -92,5 +93,5 @@
* {{{examples/creatingskins.html}Creating a Skin for the Maven Site Plugin}}
- * {{{examples/site-deploy-to-sourceforge.net.html}Deploy to
sourceforge.net}}
+ * {{{examples/site-deploy-to-sourceforge.net.html}Deploying to
sourceforge.net}}
