svn commit: r936985 - in /websites/staging/commons/trunk/content: ./ commons-parent-pom.html

[bu...@apache.org]

Author: buildbot
Date: Tue Jan 20 17:31:54 2015
New Revision: 936985

Log:
Staging update by buildbot for commons

Modified:
    websites/staging/commons/trunk/content/   (props changed)
    websites/staging/commons/trunk/content/commons-parent-pom.html

Propchange: websites/staging/commons/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Jan 20 17:31:54 2015
@@ -1 +1 @@
-1653295
+1653308

Modified: websites/staging/commons/trunk/content/commons-parent-pom.html
==============================================================================
--- websites/staging/commons/trunk/content/commons-parent-pom.html (original)
+++ websites/staging/commons/trunk/content/commons-parent-pom.html Tue Jan 20 17:31:54 2015
@@ -232,7 +232,7 @@
       
 <p>
         Using a <i>parent pom</i> reduces the build configuration required for each individual
-        component and <i>standardizes</i> the builds accross commons components.
+        component and <i>standardizes</i> the builds across Commons components.
       </p>
 
       
@@ -358,7 +358,7 @@
           </li>
           
 <li>
-            <b>javadoc and source jars</b>
+            <b>Javadoc and source jars</b>
           </li>
         </ul>
 
@@ -736,6 +736,58 @@
       </div>
 
     </div>
+
+    
+<div class="section">
+<h2><a name="Properties"></a>Properties</h2>
+
+      
+<p>
+      The parent pom defines many properties. These provide the defaults for various aspects of the pom configuration.
+      In most cases, the defaults are the best choice, but in some cases it may be necessary to override the value of a
+      property - for example if a new version of a plugin has been released, and the parent POM has not yet been updated.
+      </p>
+
+      
+<div class="section">
+<h3><a name="Overriding_properties"></a>Overriding properties</h3>
+      
+<p>
+      Properties defined in the parent POM can be overriden on the command line, for example:
+        </p>
+<div class="source">
+<pre>mvn apache-rat:rat -Dcommons.rat.version=0.11</pre></div>
+      This works best for temporary overrides. For more permanent overrides, just add the new property definition to the
+      component POM. Please ensure the override is commented, so it can be removed when no longer necessary.
+      
+      </div>
+
+      
+<div class="section">
+<h3><a name="Version_properties"></a>Version properties</h3>
+        
+<p>
+          Most of the plugin versions defined in the parent POM are defined using properties.
+          For example, commons.rat.version defines the version of Apache RAT.
+          Please see the POM for the list.
+      </p>
+      </div>
+
+      
+<div class="section">
+<h3><a name="Configuration_properties"></a>Configuration properties</h3>
+        
+<p>
+          There are some properties which control the behaviour of the plugins, for example:
+        </p>
+        
+<ul>
+          
+<li>commons.changes.onlyCurrentVersion - (default false) change this to true to limit the Jira changes list to the current version (any -SNAPSHOT suffix is ignored) only</li>
+        </ul>
+      </div>
+
+    </div>
 
     
 <div class="section">