[jboss-svn-commits] JBL Code SVN: r13764 - in labs/jbossrules/trunk/documentation/manual/en: Chapter-Release_Notes and 1 other directory.

[jboss-svn-commits at lists.jboss.org]

Author: fmeyer
Date: 2007-07-24 11:36:30 -0400 (Tue, 24 Jul 2007)
New Revision: 13764

Modified:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Release_Notes/Section-Upgrade_tips.xml
Log:
Upgrading drools update tool section 



Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml	2007-07-24 15:11:23 UTC (rev 13763)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml	2007-07-24 15:36:30 UTC (rev 13764)
@@ -57,6 +57,11 @@
   <section>
     <title>Building the Manual</title>
 
+	<para>
+		The building of the manual is now integrated into the maven build process, and is built by either using the profile (-Ddocumentation) switch or 
+		cding into the main directory. The manual can still be built from ant command line too by cding into the documentation/manual itself.
+	</para>
+
     <para>Drools uses <indexterm>
         <primary>docbook</primary>
       </indexterm>Docbook for this manual. Ant is used internally in maven to build documents and this build produces three different formats, 

Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Release_Notes/Section-Upgrade_tips.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Release_Notes/Section-Upgrade_tips.xml	2007-07-24 15:11:23 UTC (rev 13763)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Release_Notes/Section-Upgrade_tips.xml	2007-07-24 15:36:30 UTC (rev 13764)
@@ -8,7 +8,7 @@
   discussed in the maiil list and blogs.</para>
 
   <para>This section of the manual is a work in progress and will document a
-  simple how-to on upgrading from Drools 3.0.x to Drools 4.0.x. </para>
+  simple how-to on upgrading from Drools 3.0.x to Drools 4.0.x.</para>
 
   <section>
     <title>API changes</title>
@@ -136,11 +136,11 @@
       <para>Drools 3.0.x did not had native support for primitive types and
       consequently, it auto-boxed all primitives in it's respective wrapper
       classes. That way, any use of a boxed variable binding required a manual
-      unbox. </para>
+      unbox.</para>
 
       <para>Drools 4.0.x has full support for primitive types and does not
       wrap values anymore. So, all previous unwrap method calls must be
-      removed from the DRL. </para>
+      removed from the DRL.</para>
 
       <example>
         <title>Drools 3.0.x manual unwrap</title>
@@ -171,11 +171,16 @@
   </section>
 
   <section>
+     
+
     <title>Drools Update Tool</title>
 
+     
+
     <para>The Drools Update tools is a simple program to help with the upgrade
     of DRL files from Drools 3.0.x to Drools 4.0.x.</para>
 
+
     <para>At this point, its main objective is to upgrade the memory action
     calls from 3.0.x to 4.0.x, but expect it to grow over the next few weeks
     covering additional scenarios. It is important to note that it does not
@@ -184,6 +189,45 @@
     and as so, it is a safe tool to use for upgrade large sets of rule
     files.</para>
 
-    <para></para>
+	<para>
+		
+	</para>
+
+
+    <para>The drools update tool can be found as a maven project in the
+    following source repository
+    http://anonsvn.labs.jboss.com/labs/jbossrules/trunk/experimental/drools-update/
+    you just need to check it out, and execute the maven clean install action with the
+    project's pom.xml file. After resolve all the class path dependencies you
+    are able to run the toll with the following command:</para>
+
+    <programlisting>java -cp $CLASSPATH org.drools.tools.update.UpdateTool -f &lt;filemask&gt; [-d &lt;basedir&gt;] [-s &lt;sufix&gt;]</programlisting>
+
+	<para> 
+		The program parameters are very easy to understand as following.
+		
+	 <itemizedlist>
+	      <listitem>
+	        <para>-h,--help, Shows a very simple list the usage help</para>
+	      </listitem>
+
+	      <listitem>
+	        <para>-d your source base directory</para>
+	      </listitem>
+	
+	      <listitem>
+	        <para>-f pattern for the files to be updated. The format is the same as used by ANT:
+		       * = single file, directory
+               ** = any level of subdirectories
+               EXAMPLE:
+               src/main/resources/**/*.drl = matches all DRL files inside any subdirectory of /src/main/resources
+		 	</para>
+	      </listitem>
+	
+	      <listitem>
+	        <para> -s,--sufix    the sufix to be added to all updated files</para>
+	      </listitem>
+	 </itemizedlist>
+	</para>
   </section>
 </section>
\ No newline at end of file