Scarab commit: svn commit: r11071 - branches/release/0.22: . xdocs/howto

Author: jhoech
Date: 2012-02-21 03:17:19-0800
New Revision: 11071

Modified:
   branches/release/0.22/maven.xml
   branches/release/0.22/project.properties
   branches/release/0.22/project.xml
   branches/release/0.22/scarab_properties.xml
   branches/release/0.22/xdocs/howto/build-docs-howto.xml

Log:
FIX - "maven site" goal again did not build anymore because of version incompatibilities for velocity 1.6.3. This is why a property was introduced for this to switch version of velocity temporarily.

Modified: branches/release/0.22/maven.xml
Url: http://scarab.tigris.org/source/browse/scarab/branches/release/0.22/maven.xml?view=diff&pathrev=11071&r1=11070&r2=11071
==============================================================================
--- branches/release/0.22/maven.xml	(original)
+++ branches/release/0.22/maven.xml	2012-02-21 03:17:19-0800
@@ -250,6 +250,11 @@
     <!-- build docs before maven site is generated       -->
 	<!-- =============================================== -->
     <preGoal name="site">
+		<echo>
+Ensure that "maven.velocity.version" is set to 
+an applicable version number, such as 1.5 or 1.4.
+Current value is: ${maven.velocity.version}
+		</echo>
        <attainGoal name="sdocbook"/>
 <!--        <attainGoal name="torque:doc"/> -->
        <attainGoal name="javadoc"/>

Modified: branches/release/0.22/project.properties
Url: http://scarab.tigris.org/source/browse/scarab/branches/release/0.22/project.properties?view=diff&pathrev=11071&r1=11070&r2=11071
==============================================================================
--- branches/release/0.22/project.properties	(original)
+++ branches/release/0.22/project.properties	2012-02-21 03:17:19-0800
@@ -2001,6 +2001,7 @@
 #   statcvs.verbose
 #   statcvs.history
 #   statcvs.log.options
+#   maven.velocity.version
 # 
 #  Maven  Properties
 # 
@@ -2016,6 +2017,17 @@
 statcvs.history=false
 statcvs.log.options=-d 2004-01-01<
 
+# ----------------------
+# maven.velocity.version
+# ----------------------
+#
+# Version flag for velocity used by maven build. 
+# 			You have to change this value e.g. to "1.5" for maven goal "site".
+# 			This is necessary for the sake of version incompatiblities
+# 			of the maven xdoc plugin.
+
+maven.velocity.version=1.6.3
+
 # ==================
 # End of Group maven
 # ==================

Modified: branches/release/0.22/project.xml
Url: http://scarab.tigris.org/source/browse/scarab/branches/release/0.22/project.xml?view=diff&pathrev=11071&r1=11070&r2=11071
==============================================================================
--- branches/release/0.22/project.xml	(original)
+++ branches/release/0.22/project.xml	2012-02-21 03:17:19-0800
@@ -542,7 +542,7 @@
     <dependency>
       <groupId>velocity</groupId>
       <artifactId>velocity</artifactId>
-      <version>1.6.3</version>
+      <version>${maven.velocity.version}</version>
       <type>jar</type>
       <properties>
         <war.bundle>true</war.bundle>

Modified: branches/release/0.22/scarab_properties.xml
Url: http://scarab.tigris.org/source/browse/scarab/branches/release/0.22/scarab_properties.xml?view=diff&pathrev=11071&r1=11070&r2=11071
==============================================================================
--- branches/release/0.22/scarab_properties.xml	(original)
+++ branches/release/0.22/scarab_properties.xml	2012-02-21 03:17:19-0800
@@ -2602,6 +2602,15 @@
          <customization modification="optional">advanced</customization>
         <file/>
       </property>
+	  <property>
+			<name>maven.velocity.version</name>
+			<default>1.6.3</default>
+			<type>Build</type>
+			<details>Version flag for velocity used by maven build. 
+			You have to change this value e.g. to "1.5" for maven goal "site".
+			This is necessary for the sake of version incompatiblities
+			of the maven xdoc plugin.</details>
+	  </property>
     </group>
 
     <group name="eclipse">

Modified: branches/release/0.22/xdocs/howto/build-docs-howto.xml
Url: http://scarab.tigris.org/source/browse/scarab/branches/release/0.22/xdocs/howto/build-docs-howto.xml?view=diff&pathrev=11071&r1=11070&r2=11071
==============================================================================
--- branches/release/0.22/xdocs/howto/build-docs-howto.xml	(original)
+++ branches/release/0.22/xdocs/howto/build-docs-howto.xml	2012-02-21 03:17:19-0800
@@ -23,6 +23,11 @@
 	If you don't want to bother to run the unit tests, then run: <source>maven site -Dmaven.test.skip=true</source>
 	This will generate all the site documentation, as well as the FAQ, Javadocs, and various code analysis reports in the directory /target/docs.
 	</p>
+	<p>So far so good, but: For compatibility reasons maven site plugin cannot handle the docs if velocity version is set to any wrong version.
+	It is recommended to use 1.5 here. See documentation site for maven xdoc plugin, too. Problem is: Scarab uses another version of velocity,
+	as it is good for the xdoc plugin. This is why another important build property named: maven.velocity.version, exists. 
+	To build the docs properly you have to set this property manually: <source>maven site -Dmaven.velocity.version=1.5</source> or use an adapted batch script.
+	</p>
 	</subsection>
 	<subsection name="Used Plugins">
 	<p>

------------------------------------------------------
http://scarab.tigris.org/ds/viewMessage.do?dsForumId=3577&dsMessageId=2925074