maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject svn commit: r1561472 - /maven/plugins/trunk/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java
Date Sun, 26 Jan 2014 09:30:10 GMT
Author: hboutemy
Date: Sun Jan 26 09:30:10 2014
New Revision: 1561472

URL: http://svn.apache.org/r1561472
Log:
improved javadoc/goal documentation

Modified:
    maven/plugins/trunk/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java

Modified: maven/plugins/trunk/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java?rev=1561472&r1=1561471&r2=1561472&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java
(original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java
Sun Jan 26 09:30:10 2014
@@ -71,7 +71,18 @@ public abstract class AbstractScmPublish
     protected String pubScmUrl;
 
     /**
-     * Location where the scm check-out is done.
+     * If the checkout directory exists and this flag is activated, the plugin will try an
SCM-update rather
+     * than delete then checkout.
+     */
+    @Parameter ( property = "scmpublish.tryUpdate", defaultValue = "false" )
+    protected boolean tryUpdate;
+
+   /**
+     * Location where the scm check-out is done. By default, scm checkout is done in build
(target) directory,
+     * which is deleted on every <code>mvn clean</code>. To avoid this and get
better performance, configure
+     * this location outside build structure and set <code>tryUpdate</code> to
<code>true</code>.
+     * See <a href="http://maven.apache.org/plugins/maven-scm-publish-plugin/various-tips.html#Improving_SCM_Checkout_Performance">
+     * Improving SCM Checkout Performance</a> for more information.
      */
     @Parameter ( property = "scmpublish.checkoutDirectory",
                  defaultValue = "${project.build.directory}/scmpublish-checkout" )
@@ -156,13 +167,6 @@ public abstract class AbstractScmPublish
     protected String siteOutputEncoding;
 
     /**
-     * If the checkout directory exists and this flag is activated, the plugin will try an
SCM-update rather
-     * than delete then checkout.
-     */
-    @Parameter ( property = "scmpublish.tryUpdate", defaultValue = "false" )
-    protected boolean tryUpdate;
-
-    /**
      * Do not delete files to the scm
      */
     @Parameter ( property = "scmpublish.skipDeletedFiles", defaultValue = "false" )



Mime
View raw message