[hibernate-commits] Hibernate SVN: r10336 - in trunk/HibernateExt/tools/doc/reference/en: . modules

[hibernate-commits at lists.jboss.org]

Author: max.andersen at jboss.com
Date: 2006-08-24 06:30:41 -0400 (Thu, 24 Aug 2006)
New Revision: 10336

Modified:
   trunk/HibernateExt/tools/doc/reference/en/master.xml
   trunk/HibernateExt/tools/doc/reference/en/modules/ant.xml
Log:
doc

Modified: trunk/HibernateExt/tools/doc/reference/en/master.xml
===================================================================
--- trunk/HibernateExt/tools/doc/reference/en/master.xml	2006-08-24 10:30:15 UTC (rev 10335)
+++ trunk/HibernateExt/tools/doc/reference/en/master.xml	2006-08-24 10:30:41 UTC (rev 10336)
@@ -14,7 +14,7 @@
 
     <subtitle>Reference Guide</subtitle>
 
-    <releaseinfo>3.2.0.beta6</releaseinfo>
+    <releaseinfo>3.2.0.beta7</releaseinfo>
 
     <mediaobject>
       <imageobject>

Modified: trunk/HibernateExt/tools/doc/reference/en/modules/ant.xml
===================================================================
--- trunk/HibernateExt/tools/doc/reference/en/modules/ant.xml	2006-08-24 10:30:15 UTC (rev 10335)
+++ trunk/HibernateExt/tools/doc/reference/en/modules/ant.xml	2006-08-24 10:30:41 UTC (rev 10336)
@@ -13,6 +13,16 @@
     This jar is 100% independent from the eclipse platform and can thus be
     used independently of eclipse.</para>
 
+    <para>
+    Note: until Hibernate 3.2 and related libraries are finally
+    released there might be incompabilities with respect to the tools.
+    Thus to avoid any confusion it is recommended to use the
+    hibernate3.jar &amp; hibernate-annotations.jar bundled with the
+    tools when you want to use the Ant tasks. Do not worry about using
+    e.g. Hibernate 3.2 jar's with e.g. an Hibernate 3.1 project since
+    the output generated will work with previous Hibernate 3 versions.
+    </para>   
+
     <section>
       <title>The <literal>&lt;hibernatetool&gt;</literal> ant Task</title>
 
@@ -357,6 +367,8 @@
               <area coords="4 57" id="xcfg2" />
 
               <area coords="5 57" id="xcfg3" />
+              <area coords="6 57" id="xcfg4" />
+              <area coords="7 57" id="xcfg5" />
             </areaspec>
 
             <programlisting><![CDATA[<jdbcconfiguration
@@ -364,19 +376,21 @@
   packagename="package.name"
   revengfile="hibernate.reveng.xml"
   reversestrategy="ReverseEngineeringStrategy classname"
+  detectmanytomany="true|false"
+  detectoptmisticlock="true|false"
 >
   ...
 </jdbcconfiguration>]]></programlisting>
 
             <calloutlist>
               <callout arearefs="xcfg1">
-                <para>packagename (optional): The default package name to use
+                <para><literal>packagename</literal> (optional): The default package name to use
                 when mappings for classes is created</para>
               </callout>
 
               <callout arearefs="xcfg2">
                 <para><literal>revengfile</literal> (optional): name of
-                reveng.xml that allows you to control varios aspects of the
+                reveng.xml that allows you to control various aspects of the
                 reverse engineering.</para>
               </callout>
 
@@ -390,6 +404,13 @@
                 addition to) a reveng.xml file gives you full programmatic
                 control of the reverse engineering.</para>
               </callout>
+
+              <callout arearefs="xcfg4">
+                <para>detectManytoMany (default:true): If true (the default) tables which are pure many-to-many link tables will be mapped as such. A pure many-to-many table is one which primary-key contains has exactly two foreign-keys pointing to other entity tables and has no other columns.</para>
+              </callout>
+              <callout arearefs="xcfg5">
+                <para>detectOptimisticLock (efault:true): If true columns named VERSION or TIMESTAMP with appropriate types will be mapped with the apropriate optimistic locking corresponding to <literal>&lt;version&gt;</literal> or <literal>&lt;timestamp&gt;</literal></para>
+              </callout>
             </calloutlist>
           </programlistingco></para>