commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1653308 - /commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml
Date Tue, 20 Jan 2015 17:31:42 GMT
Author: sebb
Date: Tue Jan 20 17:31:42 2015
New Revision: 1653308

URL: http://svn.apache.org/r1653308
Log:
More updates

Modified:
    commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml

Modified: commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml
URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml?rev=1653308&r1=1653307&r2=1653308&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml (original)
+++ commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml Tue Jan 20 17:31:42 2015
@@ -43,7 +43,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>
 
       <subsection name="Build">
@@ -129,7 +129,7 @@
             <strong>Signatures and Checksums</strong>
           </li>
           <li>
-            <strong>javadoc and source jars</strong>
+            <strong>Javadoc and source jars</strong>
           </li>
         </ul>
 
@@ -411,6 +411,42 @@
       </subsection>
 
     </section>
+
+    <section name="Properties">
+
+      <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>
+
+      <subsection name="Overriding properties">
+      <p>
+      Properties defined in the parent POM can be overriden on the command line, for example:
+        <source>mvn apache-rat:rat -Dcommons.rat.version=0.11</source>
+      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.
+      </p>
+      </subsection>
+
+      <subsection name="Version properties">
+        <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>
+      </subsection>
+
+      <subsection name="Configuration properties">
+        <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>
+      </subsection>
+
+    </section>
 
     <section name="Profiles">
 



Mime
View raw message