Author: olamy
Date: Tue Sep 4 21:49:02 2012
New Revision: 1380908
URL: http://svn.apache.org/viewvc?rev=1380908&view=rev
Log:
fix documentation
Modified:
maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm
maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt
Modified:
maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm?rev=1380908&r1=1380907&r2=1380908&view=diff
==============================================================================
---
maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm
(original)
+++
maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm
Tue Sep 4 21:49:02 2012
@@ -35,7 +35,7 @@ Maven Multi Module Configuration
+-----------------------
<properties>
- <siteContent.path>${user.home}/my-site-deploy</siteContent.path>
+
<siteContent.path>${project.build.directory}/my-site-deploy</siteContent.path>
<scmCheckout.path>${user.home}/my-site-content</scmCheckout.path>
<siteDeploy.url>file://${siteContent.path}</siteDeploy.url>
</properties>
Modified: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt?rev=1380908&r1=1380907&r2=1380908&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt
(original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt Tue Sep
4 21:49:02 2012
@@ -41,27 +41,21 @@ Maven SCM Publish Plugin
Implementation
+ The plugin proceed to publish your website using the following steps.
- The plugin provides two goals: <<prepare>> and <<publish>>.
- (TODO: deprecated by new <<publish-scm>> goal, which does everything in
one step)
-
- The prepare goal checks out the contents of a directory from
+ The prepare phase checks out the contents of a directory from
the SCM into (by default) <<<target/scmpublish-checkout>>>. It
then lists the files known to the SCM and stores them
in (by default) <<<target/scmpublish-inventory.js>>>. This provides
the point of reference for an eventual SCM checkin. Then it deletes every
files to let a clean place for site generation.
- After running the prepare goal, the POM must run <<<site>>> phase then
- <<<site:stage>>> goal, with the <stagingDirectory> set to
- <<<target/scmpublish-checkout>>>.
-
- Finally, the <<publish>> goal compares the output of <<<site:stage>>>
- with the inventory from the <<prepare>> goal, and issues
+ Finally, the publish phase compares the output of the generated site
+ with the inventory from the prepare phase, and issues
appropriate SCM commands to add and delete, followed by a
checkin.
- The <scmpublish.dryRun> parameter to the <<publish>> goal avoids all
+ The <scmpublish.dryRun> parameter to the plugin avoids all
SCM operations, and simply logs out the added, deleted,
and changed files.
@@ -84,6 +78,8 @@ mvn scm-publish:publish-scm -Dscmpublish
See {{{./examples/importing-maven-site.html}maven.apache.org content
import script}} for an
example.
+ <<See {{{./various-tips.html}Some Tips}}.>>
+
Known Limitations
There are 2 known limitations:
