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

[hb...@apache.org]

Author: hboutemy
Date: Sun May 20 21:58:04 2012
New Revision: 1340854

URL: http://svn.apache.org/viewvc?rev=1340854&view=rev
Log:
added known limitations and future dreams sections

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

Modified: maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/site/apt/index.apt?rev=1340854&r1=1340853&r2=1340854&view=diff
==============================================================================
--- maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/site/apt/index.apt (original)
+++ maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/site/apt/index.apt Sun May 20 21:58:04 2012
@@ -31,7 +31,9 @@ Maven SCM Publish Plugin
     The  maven-scm-publish-plugin is a utility plugin to allow Apache
     projects to publish Maven websites via the ASF svnpubsub 
     system, and more generally to publish a site generated by Maven or any content to
-    any supported SCM.
+    any supported SCM. In addition to SCM operations, it takes care to
+    fix newline inconsistencies generated by <<<maven-site-plugin>>>, which prevents
+    simple content import to SCM.
 
     The plugin provides two goals: <<prepare>> and <<publish>>.
 
@@ -69,3 +71,31 @@ mvn scm-publish:publish-scm -Dscmpublish
 
     SCM content will be checked-out to a temporary directory, then local content will
     be applied to the check-out, before it is checked-in back.
+
+Known Limitations
+
+    There are 2 known limitations:
+    
+    * the plugin doesn't create the initial SCM directory, it just import content into an
+    existing SCM directory,
+
+    * 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 ocntent to the same directory (like Surefire or Maven Plugin Tools, which have a
+    base directory and one plugin in <<</plugins/>>>), this staging area can't be simply imported.
+
+    []
+
+Future Dreams
+
+    Ideally, scm urls would be supported in <<<\<distributionManagement>>>> section of the POM, then
+    publishing would simply be <<<mvn site-deploy>>>, without any problems for non-flat multi-modules
+    sites.
+
+    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)
+
+    * improve {{{/wagon/wagon-providers/wagon-scm/}<<<wagon-scm>>>}} to put a whole directory content
+      in one commit, and not with one commit per file.