[hibernate-commits] Hibernate SVN: r19240 - in core/trunk: entitymanager/src/main/docbook/en/modules and 1 other directory.

hibernate-commits at lists.jboss.org hibernate-commits at lists.jboss.org
Thu Apr 15 05:37:37 EDT 2010


Author: epbernard
Date: 2010-04-15 05:37:36 -0400 (Thu, 15 Apr 2010)
New Revision: 19240

Modified:
   core/trunk/annotations/src/main/docbook/en/modules/setup.xml
   core/trunk/entitymanager/src/main/docbook/en/modules/configuration.xml
Log:
HHH-5069 update setup sections to reflect new distribution packages.

Modified: core/trunk/annotations/src/main/docbook/en/modules/setup.xml
===================================================================
--- core/trunk/annotations/src/main/docbook/en/modules/setup.xml	2010-04-15 02:01:34 UTC (rev 19239)
+++ core/trunk/annotations/src/main/docbook/en/modules/setup.xml	2010-04-15 09:37:36 UTC (rev 19240)
@@ -32,14 +32,13 @@
 
     <itemizedlist>
       <listitem>
-        <para>Make sure you have JDK 5.0 installed or above.</para>
+        <para>Make sure you have JDK 5.0 or above installed.</para>
       </listitem>
 
       <listitem>
-        <para><ulink url="http://www.hibernate.org/6.html">Download</ulink>
-        and unpack the Hibernate Core distribution from the Hibernate website.
-        Hibernate 3.5 and onward contains the Hibernate Annotation
-        jars.</para>
+        <para>Download and unpack the Hibernate Core distribution from the
+        Hibernate website. Hibernate 3.5 and onward contains Hibernate
+        Annotations.</para>
       </listitem>
 
       <listitem>
@@ -51,7 +50,7 @@
   &lt;dependencies&gt;
     &lt;dependency&gt;
       &lt;groupId&gt;org.hibernate&lt;/groupId&gt;
-      &lt;artifactId&gt;hibernate-core&lt;/artifactId&gt;
+      &lt;artifactId&gt;hibernate-annotations&lt;/artifactId&gt;
       &lt;version&gt;${hibernate-core-version}&lt;/version&gt;
     &lt;/dependency&gt;
   &lt;/dependencies&gt;
@@ -66,15 +65,15 @@
     <para>First, set up your classpath (after you have created a new project
     in your favorite IDE): <itemizedlist>
         <listitem>
-          <para>Copy all Hibernate3 core and required 3rd party library
-          files.</para>
+          <para>Copy <filename>hibernate3.jar</filename> and the required 3rd
+          party libraries available in
+          <filename>lib/required</filename>.</para>
         </listitem>
 
         <listitem>
-          <para>Copy <filename>hibernate-annotations.jar</filename>,
-          <filename>lib/hibernate-comons-annotations.jar</filename> and
-          <filename>lib/hibernate-jpa-2.0-api.jar</filename> from the
-          distribution to your classpath as well.</para>
+          <para>Copy
+          <filename>lib/jpa/hibernate-jpa-2.0-api-1.0.0.Final.jar</filename>
+          to your classpath as well.</para>
         </listitem>
       </itemizedlist></para>
 
@@ -92,8 +91,9 @@
 
     <para>We recommend you use <ulink
     url="http://validator.hibernate.org">Hibernate Validator</ulink> and the
-    Bean Validation specification capabilities. Download Hibernate Validator 4
-    or above from the Hibernate website and add
+    Bean Validation specification capabilities as its integration with Java
+    Persistence 2 has been standardized. Download Hibernate Validator 4 or
+    above from the Hibernate website and add
     <filename>hibernate-validator.jar</filename> and
     <filename>validation-api.jar</filename> in your classpath. Alternatively
     add the following dependency in your <filename>pom.xml</filename>.</para>
@@ -114,9 +114,8 @@
     <para>If you wish to use <ulink
     url="http://search.hibernate.org">Hibernate Search</ulink>, download it
     from the Hibernate website and add
-    <filename>hibernate-search.jar</filename> and
-    <filename>lucene-core-x.y.z.jar</filename> in your classpath.
-    Alternatively add the following dependency in your
+    <filename>hibernate-search.jar</filename> and its dependencies in your
+    classpath. Alternatively add the following dependency in your
     <filename>pom.xml</filename>.</para>
 
     <programlisting language="XML" role="XML">&lt;project&gt;
@@ -325,4 +324,4 @@
     url="http://www.hibernate.org/hib_docs/v3/reference/en/html_single/#configuration-logging">Logging</ulink>
     in the Hibernate Core documentation.</para>
   </section>
-</chapter>
\ No newline at end of file
+</chapter>

Modified: core/trunk/entitymanager/src/main/docbook/en/modules/configuration.xml
===================================================================
--- core/trunk/entitymanager/src/main/docbook/en/modules/configuration.xml	2010-04-15 02:01:34 UTC (rev 19239)
+++ core/trunk/entitymanager/src/main/docbook/en/modules/configuration.xml	2010-04-15 09:37:36 UTC (rev 19240)
@@ -50,12 +50,21 @@
       </listitem>
     </itemizedlist>
 
-    <para>The following libraries have to be in your classpath:
-    hibernate-core.jar, hibernate-annotations.jar,
-    hibernate-commons-annotations.jar, hibernate-entitymanager.jar and all
-    needed third party libraries for each package (incl.
-    hibernate-jpa-2.0-api.jar).</para>
+    <para>Download the Hibernate Core distribution. Set up your classpath
+    (after you have created a new project in your favorite IDE):<itemizedlist>
+        <listitem>
+          <para>Copy <filename>hibernate3.jar</filename> and the required 3rd
+          party libraries available in
+          <filename>lib/required</filename>.</para>
+        </listitem>
 
+        <listitem>
+          <para>Copy
+          <filename>lib/jpa/hibernate-jpa-2.0-api-1.0.0.Final.jar</filename>
+          to your classpath as well.</para>
+        </listitem>
+      </itemizedlist></para>
+
     <note>
       <title>What is hibernate-jpa-2.0-api-x.y.z.jar</title>
 
@@ -65,7 +74,8 @@
       server (like JBoss AS 6 for example).</para>
     </note>
 
-    <para>If you use Maven, add the following dependencies</para>
+    <para>Alternatively, if you use Maven, add the following
+    dependencies</para>
 
     <programlisting language="XML" role="XML">&lt;project ...&gt;
   ...
@@ -80,6 +90,48 @@
 
     <para>All the required dependencies like hibernate-core and
     hibernate-annotations will be dragged transitively.</para>
+
+    <para>We recommend you use <ulink
+    url="http://validator.hibernate.org">Hibernate Validator</ulink> and the
+    Bean Validation specification capabilities as its integration with Java
+    Persistence 2 has been standardized. Download Hibernate Validator 4 or
+    above from the Hibernate website and add
+    <filename>hibernate-validator.jar</filename> and
+    <filename>validation-api.jar</filename> in your classpath. Alternatively
+    add the following dependency in your <filename>pom.xml</filename>.</para>
+
+    <programlisting language="XML" role="XML">&lt;project&gt;
+  ...
+  &lt;dependencies&gt;
+    &lt;dependency&gt;
+      &lt;groupId&gt;org.hibernate&lt;/groupId&gt;
+      &lt;artifactId&gt;hibernate-validator&lt;/artifactId&gt;
+      &lt;version&gt;${hibernate-validator-version}&lt;/version&gt;
+    &lt;/dependency&gt;
+    ...
+  &lt;/dependencies&gt;
+  ...
+&lt;/project&gt;</programlisting>
+
+    <para>If you wish to use <ulink
+    url="http://search.hibernate.org">Hibernate Search</ulink> (full-text
+    search for Hibernate aplications), download it from the Hibernate website
+    and add <filename>hibernate-search.jar</filename> and its dependencies in
+    your classpath. Alternatively add the following dependency in your
+    <filename>pom.xml</filename>.</para>
+
+    <programlisting language="XML" role="XML">&lt;project&gt;
+  ...
+  &lt;dependencies&gt;
+    &lt;dependency&gt;
+      &lt;groupId&gt;org.hibernate&lt;/groupId&gt;
+      &lt;artifactId&gt;hibernate-search&lt;/artifactId&gt;
+      &lt;version&gt;${hibernate-search-version}&lt;/version&gt;
+    &lt;/dependency&gt;
+    ...
+  &lt;/dependencies&gt;
+  ...
+&lt;/project&gt;</programlisting>
   </section>
 
   <section id="setup-configuration"



More information about the hibernate-commits mailing list