From 5da56b788181660674439d717db80b0024b73658 Mon Sep 17 00:00:00 2001 From: Emmanuel Bernard Date: Thu, 15 Apr 2010 09:37:36 +0000 Subject: [PATCH] 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 --- .../src/main/docbook/en/modules/setup.xml | 35 +++++----- .../main/docbook/en/modules/configuration.xml | 64 +++++++++++++++++-- 2 files changed, 75 insertions(+), 24 deletions(-) diff --git a/annotations/src/main/docbook/en/modules/setup.xml b/annotations/src/main/docbook/en/modules/setup.xml index b35ba33e4f..4d2281975c 100644 --- a/annotations/src/main/docbook/en/modules/setup.xml +++ b/annotations/src/main/docbook/en/modules/setup.xml @@ -32,14 +32,13 @@ - Make sure you have JDK 5.0 installed or above. + Make sure you have JDK 5.0 or above installed. - Download - and unpack the Hibernate Core distribution from the Hibernate website. - Hibernate 3.5 and onward contains the Hibernate Annotation - jars. + Download and unpack the Hibernate Core distribution from the + Hibernate website. Hibernate 3.5 and onward contains Hibernate + Annotations. @@ -51,7 +50,7 @@ <dependencies> <dependency> <groupId>org.hibernate</groupId> - <artifactId>hibernate-core</artifactId> + <artifactId>hibernate-annotations</artifactId> <version>${hibernate-core-version}</version> </dependency> </dependencies> @@ -66,15 +65,15 @@ First, set up your classpath (after you have created a new project in your favorite IDE): - Copy all Hibernate3 core and required 3rd party library - files. + Copy hibernate3.jar and the required 3rd + party libraries available in + lib/required. - Copy hibernate-annotations.jar, - lib/hibernate-comons-annotations.jar and - lib/hibernate-jpa-2.0-api.jar from the - distribution to your classpath as well. + Copy + lib/jpa/hibernate-jpa-2.0-api-1.0.0.Final.jar + to your classpath as well. @@ -92,8 +91,9 @@ We recommend you use Hibernate Validator 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 hibernate-validator.jar and validation-api.jar in your classpath. Alternatively add the following dependency in your pom.xml. @@ -114,9 +114,8 @@ If you wish to use Hibernate Search, download it from the Hibernate website and add - hibernate-search.jar and - lucene-core-x.y.z.jar in your classpath. - Alternatively add the following dependency in your + hibernate-search.jar and its dependencies in your + classpath. Alternatively add the following dependency in your pom.xml. <project> @@ -325,4 +324,4 @@ private static final SessionFactory sessionFactory; url="http://www.hibernate.org/hib_docs/v3/reference/en/html_single/#configuration-logging">Logging in the Hibernate Core documentation. - \ No newline at end of file + diff --git a/entitymanager/src/main/docbook/en/modules/configuration.xml b/entitymanager/src/main/docbook/en/modules/configuration.xml index 8ab5dbd21a..4c91eea1ae 100644 --- a/entitymanager/src/main/docbook/en/modules/configuration.xml +++ b/entitymanager/src/main/docbook/en/modules/configuration.xml @@ -50,11 +50,20 @@ - 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). + Download the Hibernate Core distribution. Set up your classpath + (after you have created a new project in your favorite IDE): + + Copy hibernate3.jar and the required 3rd + party libraries available in + lib/required. + + + + Copy + lib/jpa/hibernate-jpa-2.0-api-1.0.0.Final.jar + to your classpath as well. + + What is hibernate-jpa-2.0-api-x.y.z.jar @@ -65,7 +74,8 @@ server (like JBoss AS 6 for example). - If you use Maven, add the following dependencies + Alternatively, if you use Maven, add the following + dependencies <project ...> ... @@ -80,6 +90,48 @@ All the required dependencies like hibernate-core and hibernate-annotations will be dragged transitively. + + We recommend you use Hibernate Validator 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 + hibernate-validator.jar and + validation-api.jar in your classpath. Alternatively + add the following dependency in your pom.xml. + + <project> + ... + <dependencies> + <dependency> + <groupId>org.hibernate</groupId> + <artifactId>hibernate-validator</artifactId> + <version>${hibernate-validator-version}</version> + </dependency> + ... + </dependencies> + ... +</project> + + If you wish to use Hibernate Search (full-text + search for Hibernate aplications), download it from the Hibernate website + and add hibernate-search.jar and its dependencies in + your classpath. Alternatively add the following dependency in your + pom.xml. + + <project> + ... + <dependencies> + <dependency> + <groupId>org.hibernate</groupId> + <artifactId>hibernate-search</artifactId> + <version>${hibernate-search-version}</version> + </dependency> + ... + </dependencies> + ... +</project>