svn commit: r1561310 - /maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm

[hb...@apache.org]

Author: hboutemy
Date: Sat Jan 25 13:49:31 2014
New Revision: 1561310

URL: http://svn.apache.org/r1561310
Log:
note about MSITE-121 (which is now fixed: whoohoo!)

Modified:
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm

Modified: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm?rev=1561310&r1=1561309&r2=1561310&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm (original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm Sat Jan 25 13:49:31 2014
@@ -34,17 +34,19 @@ ${project.name}
     to publish Maven websites via the ASF svnpubsub system
 
     In addition to SCM operations, it takes care to fix newline inconsistencies
-    generated by <<<maven-site-plugin>>>, which prevents simple content import to SCM.
+    generated by <<<maven-site-plugin>>> (see {{{https://jira.codehaus.org/browse/MSITE-121}MSITE-121}},
+    which prevents simple content import to SCM.
 
     The plugin has been tested with git scm too and by example can push content for github pages too.
 
 
 * Implementation
 
-    The plugin works from staged website.
+    The plugin works from staged website by default (see {{{./publish-scm-mojo.html#content}<<<content>>> parameter}}).
 
     It first checks out the contents of a directory from
-    the SCM into (by default) <<<target/scmpublish-checkout>>>.
+    the SCM (see {{{./publish-scm-mojo.html#pubScmUrl}<<<pubSubUrl>>> parameter}}) into
+    <<<target/scmpublish-checkout>>> by default (see {{{./publish-scm-mojo.html#checkoutDirectory}<<<checkoutDirectory>>> parameter).
 
     Then locally staged content is applied to the check-out, issuing
     appropriate SCM commands to add and delete entries, followed by a
@@ -79,13 +81,13 @@ mvn scm-publish:publish-scm -Dscmpublish
 
     There are 2 known limitations:
     
-    * For svn the plugin can create the initial SCM directory if not exist. But for git by example if you use a branch
-    the branch won't be created , you have to create it manually.
+    * For svn the plugin can create the initial SCM directory if it does not exist. But for git by example if you use a branch,
+    the branch won't be created, you have to create it manually.
 
     * the plugin works well for multi-module websites publishing to a complete directory:
     you just need to publish <<<mvn site:stage>>> content. But if one module does not publish
     its content to the same directory (like Surefire or Enforcer, which have a
-    base directory and one plugin in <<</plugins/>>>), this staging area can't be simply imported,
+    base directory and one plugin in <<</plugins/>>>), this staging area can't be simply imported.
 
     []
 
@@ -98,11 +100,12 @@ mvn scm-publish:publish-scm -Dscmpublish
     To reach such a dream, there are some steps:
 
     * fix inconsistent newlines generated by <<<maven-site-plugin>>> (caused by site.vm template and
-      resources taken from skin jar without fixing newlines)
+      resources taken from skin jar without fixing newlines): {{{https://jira.codehaus.org/browse/MSITE-121}MSITE-121}}
+      is fixed in (future) maven-site-plugin 3.4,
 
     * improve {{{/wagon/wagon-providers/wagon-scm/}<<<wagon-scm>>>}} to put a whole directory content
       in one commit, and not with one commit per file.
 
     []
 
-    Then this plugin will be outdated, replaced by natural <<<maven-site-plugin:deploy>>>.
+    Then this plugin will be outdated, replaced by natural <<<maven-site-plugin:deploy>>> goal.