Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-5069 update setup sections to reflect new distribution packages. 

git-svn-id: https://svn.jboss.org/repos/hibernate/core/trunk@19240 1b8cb986-b30d-0410-93ca-fae66ebed9b2
This commit is contained in:
Emmanuel Bernard 2010-04-15 09:37:36 +00:00
parent 4470ebcd4d
commit 5da56b7881
2 changed files with 75 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
annotations/src/main/docbook/en/modules/setup.xml
View File

@ -32,14 +32,13 @@
<itemizedlist> <itemizedlist>
<listitem> <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>
<listitem> <listitem>
<para><ulink url="http://www.hibernate.org/6.html">Download</ulink> <para>Download and unpack the Hibernate Core distribution from the
and unpack the Hibernate Core distribution from the Hibernate website. Hibernate website. Hibernate 3.5 and onward contains Hibernate
Hibernate 3.5 and onward contains the Hibernate Annotation Annotations.</para>
jars.</para>
</listitem> </listitem>
<listitem> <listitem>
@ -51,7 +50,7 @@
&lt;dependencies&gt; &lt;dependencies&gt;
&lt;dependency&gt; &lt;dependency&gt;
&lt;groupId&gt;org.hibernate&lt;/groupId&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;version&gt;${hibernate-core-version}&lt;/version&gt;
&lt;/dependency&gt; &lt;/dependency&gt;
&lt;/dependencies&gt; &lt;/dependencies&gt;
@ -66,15 +65,15 @@
<para>First, set up your classpath (after you have created a new project <para>First, set up your classpath (after you have created a new project
in your favorite IDE): <itemizedlist> in your favorite IDE): <itemizedlist>
<listitem> <listitem>
<para>Copy all Hibernate3 core and required 3rd party library <para>Copy <filename>hibernate3.jar</filename> and the required 3rd
files.</para> party libraries available in
<filename>lib/required</filename>.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Copy <filename>hibernate-annotations.jar</filename>, <para>Copy
<filename>lib/hibernate-comons-annotations.jar</filename> and <filename>lib/jpa/hibernate-jpa-2.0-api-1.0.0.Final.jar</filename>
<filename>lib/hibernate-jpa-2.0-api.jar</filename> from the to your classpath as well.</para>
distribution to your classpath as well.</para>
</listitem> </listitem>
</itemizedlist></para> </itemizedlist></para>
@ -92,8 +91,9 @@
<para>We recommend you use <ulink <para>We recommend you use <ulink
url="http://validator.hibernate.org">Hibernate Validator</ulink> and the url="http://validator.hibernate.org">Hibernate Validator</ulink> and the
Bean Validation specification capabilities. Download Hibernate Validator 4 Bean Validation specification capabilities as its integration with Java
or above from the Hibernate website and add Persistence 2 has been standardized. Download Hibernate Validator 4 or
above from the Hibernate website and add
<filename>hibernate-validator.jar</filename> and <filename>hibernate-validator.jar</filename> and
<filename>validation-api.jar</filename> in your classpath. Alternatively <filename>validation-api.jar</filename> in your classpath. Alternatively
add the following dependency in your <filename>pom.xml</filename>.</para> add the following dependency in your <filename>pom.xml</filename>.</para>
@ -114,9 +114,8 @@
<para>If you wish to use <ulink <para>If you wish to use <ulink
url="http://search.hibernate.org">Hibernate Search</ulink>, download it url="http://search.hibernate.org">Hibernate Search</ulink>, download it
from the Hibernate website and add from the Hibernate website and add
<filename>hibernate-search.jar</filename> and <filename>hibernate-search.jar</filename> and its dependencies in your
<filename>lucene-core-x.y.z.jar</filename> in your classpath. classpath. Alternatively add the following dependency in your
Alternatively add the following dependency in your
<filename>pom.xml</filename>.</para> <filename>pom.xml</filename>.</para>
<programlisting language="XML" role="XML">&lt;project&gt; <programlisting language="XML" role="XML">&lt;project&gt;

64
entitymanager/src/main/docbook/en/modules/configuration.xml
View File

@ -50,11 +50,20 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>The following libraries have to be in your classpath: <para>Download the Hibernate Core distribution. Set up your classpath
hibernate-core.jar, hibernate-annotations.jar, (after you have created a new project in your favorite IDE):<itemizedlist>
hibernate-commons-annotations.jar, hibernate-entitymanager.jar and all <listitem>
needed third party libraries for each package (incl. <para>Copy <filename>hibernate3.jar</filename> and the required 3rd
hibernate-jpa-2.0-api.jar).</para> 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> <note>
<title>What is hibernate-jpa-2.0-api-x.y.z.jar</title> <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> server (like JBoss AS 6 for example).</para>
</note> </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; <programlisting language="XML" role="XML">&lt;project ...&gt;
... ...
@ -80,6 +90,48 @@
<para>All the required dependencies like hibernate-core and <para>All the required dependencies like hibernate-core and
hibernate-annotations will be dragged transitively.</para> 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>
<section id="setup-configuration" <section id="setup-configuration"