From hibernate-commits at lists.jboss.org Fri Sep 3 02:55:55 2010 Content-Type: multipart/mixed; boundary="===============3531717108967848000==" MIME-Version: 1.0 From: hibernate-commits at lists.jboss.org To: hibernate-commits at lists.jboss.org Subject: [hibernate-commits] Hibernate SVN: r20307 - in core/trunk/documentation/quickstart/src/main/docbook/en-US: content and 1 other directory. Date: Fri, 03 Sep 2010 02:55:54 -0400 Message-ID: <201009030655.o836tsfY032621@svn01.web.mwc.hst.phx2.redhat.com> --===============3531717108967848000== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: misty(a)redhat.com Date: 2010-09-03 02:55:53 -0400 (Fri, 03 Sep 2010) New Revision: 20307 Modified: core/trunk/documentation/quickstart/src/main/docbook/en-US/Hibernate_Get= ting_Started_Guide.xml core/trunk/documentation/quickstart/src/main/docbook/en-US/content/commu= nity.xml core/trunk/documentation/quickstart/src/main/docbook/en-US/content/obtai= ning.xml Log: Edits to the Getting Started Guide Modified: core/trunk/documentation/quickstart/src/main/docbook/en-US/Hibern= ate_Getting_Started_Guide.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- core/trunk/documentation/quickstart/src/main/docbook/en-US/Hibernate_Ge= tting_Started_Guide.xml 2010-09-02 06:31:15 UTC (rev 20306) +++ core/trunk/documentation/quickstart/src/main/docbook/en-US/Hibernate_Ge= tting_Started_Guide.xml 2010-09-03 06:55:53 UTC (rev 20307) @@ -11,10 +11,13 @@ Basic Information + + Set up and begin using Hibernate. @@ -23,11 +26,16 @@ Tutorials + + + Learn by doing, with guided tutorials. The referenced projects and co= de are available for download at . + Modified: core/trunk/documentation/quickstart/src/main/docbook/en-US/conten= t/community.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- core/trunk/documentation/quickstart/src/main/docbook/en-US/content/comm= unity.xml 2010-09-02 06:31:15 UTC (rev 20306) +++ core/trunk/documentation/quickstart/src/main/docbook/en-US/content/comm= unity.xml 2010-09-03 06:55:53 UTC (rev 20307) @@ -4,39 +4,38 @@ Hibernate Community = - - There are a number of ways to become involved in the Hibernate com= munity, including - - - - Trying stuff out and reporting bugs. See for - details. - - - - - Trying your hand at fixing some bugs or implementing e= nhancements. Again, see - . - - - - - l= ists a number of ways to engage in the community - including mailing lists, forums, IRC and others. - - - - - Helping improve or translate this documentation. Cont= act us on the developer mailing list - if you have interest. - - - - - Evangelizing Hibernate within your organization. - - - - - + + + Get Involved + + + Use Hibernate and report any bugs or issues you find. See + for + details. + + + + + Try your hand at fixing some bugs or implementing + enhancements. Again, see . + + + + + Engage with the community using mailing lists, forums, IRC, or other wa= ys listed at . + + + + + Help improve or translate this documentation. Contact us on + the developer mailing list if you have interest. + + + + + Spread the word. Let the rest of your organization know about the benef= its of Hibernate. + + + Modified: core/trunk/documentation/quickstart/src/main/docbook/en-US/conten= t/obtaining.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- core/trunk/documentation/quickstart/src/main/docbook/en-US/content/obta= ining.xml 2010-09-02 06:31:15 UTC (rev 20306) +++ core/trunk/documentation/quickstart/src/main/docbook/en-US/content/obta= ining.xml 2010-09-03 06:55:53 UTC (rev 20307) @@ -8,40 +8,39 @@
Release Bundle Downloads - The Hibernate team provides release bundles hosted on the Sour= ceForge File Release System, both in - ZIP and TGZ formats. A r= elease bundle contains JARs, + The Hibernate team provides release bundles hosted on the Sour= ceForge File Release System, in + ZIP and TGZ formats. Eac= h release bundle contains JARs, documentation, source code, and other information. - Navigate to and download the - desired release from the list, in your format of choice. + You can download releases of Hibernate, in your chosen format,= from the list at . hibernate3.jar is an aggregation = of all the Hibernate Core classes. - This would need to be part of your project classpath. + This must be included in your project's classpath. - The lib/required directory contai= ns jars that are - required for Hibernate to run. A= ll the jars in this directory would need - to be part of your project classpath as well. + The lib/required/ directory contains JARs Hiberna= te requires. All the jars in this directory must also be included in your = project's classpath as well. - The slf4j jar is special in that you still need fu= rther jar file(s) for it to work correctly. - Which jar(s) depends on which logging back-end you= want to use. See the - slf4j site for details. + The slf4j JAR has additional + requirements for it to function properly. The exact + requirements depend on your logging back-end. See slf4j site for details. - The /lib/jpa directory contains t= he - J= PA API jar. If you want to use the - JPA APIs or JPA annotations, this jar will need to be = part of your project classpath too. + The /lib/jpa/ directory contains the + JPA + API JAR. This JAR needs to be in your project's classpath if + you want to use the JPA APIs or JPA annotations. @@ -49,152 +48,188 @@ =
Maven Repository Artifacts - - - The authoritative repository for Hibernate artifacts is th= e JBoss - Maven repository. The team responsible for the JBoss Mave= n repository maintains a number of wiki - pages that contain important information: - - - - http://community.jboss.org/docs/DOC-14900 - - contains general information about the reposit= ory - - - - - http://community.jboss.org/docs/DOC-15170 - - contains information about setting up access t= o the repository for developers - (aka, developers working on Hibernate or JBoss= projects). - - - - - http://community.jboss.org/docs/DOC-15169 - - contains information about setting up access t= o the repository for users - (aka, consumers of Hibernate or JBoss projects= ). - - - - - + + The authoritative repository for Hibernate artifacts is the + JBoss Maven repository. The team responsible for the JBoss + Maven repository maintains a number of Wiki pages that contain + important information. + + + + Maven Repository Wiki Pages + + http:/= /community.jboss.org/docs/DOC-14900 + + + General information about the repository. + + + + + http:/= /community.jboss.org/docs/DOC-15170 + + + Information about setting up the JBoss repositories in order to do devel= opment work on JBoss projects themselves. + + + + + http:/= /community.jboss.org/docs/DOC-15169 + + + Information about setting up access to the repository to use JBoss proje= cts as part of your own software. + + + + + = - Hibernate produces a number of artifacts (all under the org.hi= bernate groupId): - - - - hibernate-core - This is the = main artifact. It contains all the - Hibernate classes (org.hibernate) needed to build applications using - the native Hibernate APIs. It includes capabiliti= es for using native Hibernate mapping - (hbm.xml) files as well as an= notations. - - - - - hibernate-entitymanager - Hib= ernate provides an implementation of - JPA. This is the artifact that - represents this JPA implementation. - - - This artifact depends on hibernate-core<= /emphasis>. - - - - - hibernate-envers - Envers is = an optional module that - provides historical auditing of changes to your en= tities. - - - This artifact depends on both hibernate-= core and - hibernate-entitymanager. - - - - - hibernate-c3p0 - Represents t= he integration between Hibernate - and the C3P0 connection pool - library. - - - This artifact depends on hibernate-core<= /emphasis>; however it would generally - be included in a project as a runtime dependency (= rarely would you need to bind against - these classes at compile time). It also pulls in = the C3P0 dependencies. - be - - - - - hibernate-proxool - Represent= s the integration between Hibernate - and the Proxool connection pool - library. - - - This artifact depends on hibernate-core<= /emphasis>; however it would generally - be included in a project as a runtime dependency (= rarely would you need to bind against - these classes at compile time). It also pulls in = the Proxool dependencies. - - - - - hibernate-ehcache - Represent= s the integration between Hibernate - and EhCache as a second level cache - implementation. - - - This artifact depends on hibernate-core<= /emphasis>; however it would generally - be included in a project as a runtime dependency (= rarely would you need to bind against - these classes at compile time). It also pulls in = the Ehcache dependencies. - - - - - hibernate-infinispan - Repres= ents the integration between Hibernate - and Inf= inispan as a second level cache - implementation. - - - This artifact depends on hibernate-core<= /emphasis>; however it would generally - be included in a project as a runtime dependency (= rarely would you need to bind against - these classes at compile time). It also pulls in = the Infinispan dependencies. - - - - - hibernate-jbosscache - Repres= ents the integration between Hibernate - and JBo= ssCache as a second level cache - implementation. - - - This artifact depends on hibernate-core<= /emphasis>; however it would generally - be included in a project as a runtime dependency (= rarely would you need to bind against - these classes at compile time). It also pulls in = the JBossCache dependencies - - - - - hibernate-oscache - Represent= s the integration between Hibernate - and OSCache as a second level cache - implementation. - - - This artifact depends on hibernate-core<= /emphasis>; however it would generally - be included in a project as a runtime dependency (= rarely would you need to bind against - these classes at compile time). It also pulls in = the OSCache dependencies. - - - - - hibernate-swarmcache - Repres= ents the integration between Hibernate - and SwarmCache as a second level cache - implementation. - - - This artifact depends on hibernate-core<= /emphasis>; however it would generally - be included in a project as a runtime dependency (= rarely would you need to bind against - these classes at compile time). It also pulls in = the SwarmCache dependencies. - - - - + Hibernate produces a number of artifacts (all under the org.hibernate g= roupId): + + + Hibernate Artifacts under groupId<systemitem>org.hibernate</syst= emitem> + + hibernate-core + + + The main artifact, which contains all the Hibernate classes, in + package org.hibernate. You need these to + build applications using the native Hibernate APIs. It includes + capabilities for using native Hibernate mapping in + hbm.xml files, as well as annotations. + + + + + hibernate-entitymanager + + + Represents Hibernate's implementation of + JPA, as specified at. + + + This artifact depends on hibernate-core + + + + + hibernate-envers + + + An optional module that provides historical auditing of changes + to your entities. + + + This artifact depends on both + hibernate-core and + hibernate-entitymanager. + + + + + hibernate-c3p0 + + + Provides integration between Hibernate and the + C3P0 connection pool library. See + for + information about C3P0. + + + This artifact depends on hibernate-core, but is= generally included in a project as a runtime dependency. It pulls in the = C3P0 dependencies automatically. + + + + + hibernate-proxool + + + Provides integration between Hibernate and the + Proxool connection pool library. See + for more + information about this library. library. + + + This artifact depends on + hibernate-core, but is generally + included in a project as a runtime dependency. It pulls in the + Proxool dependencies automatically.. + + + + + hibernate-ehcache + + + Privides integration between Hibernate and + EhCache, as a second-level cache. See + for more + information about EhCache. + + + This artifact depends on + hibernate-core, but is generally + included in a project as a runtime dependency. It pulls in the + Ehcache dependencies automatically. + + + + + hibernate-infinispan + + + Provides integration between Hibernate + and Infinispan, as a second-level cache. See = for more information about Infinispan. + + + This artifact depends on hibernate-core, but is= generally included in a project as a runtime + dependency. It pulls in the Infinispan depen= dencies automatically. + + + + + hibernate-jbosscache + + + Provides integration between Hibernate + and JBossCache, as a second-level cache. See = for information about JBossCache. + + + This artifact depends on hibernate-core, + but is generally included in a project as a runtime dependency. + It pulls in the JBossCache + dependencies automatically. + + + + + hibernate-oscache + + + Provides integration between Hibernate + and OSCache as a second-level cache. See for information about OSCache. + + + This artifact depends on hibernate-core, + but is generally included in a project as a runtime dependency. + It pulls in the OSCache dependencies automatically. + + + + + hibernate-swarmcache + + + Provides integration between Hibernate + and SwarmCache, as a second-level cache. See = for more information a= bout SwarmCache. + + + This artifact depends on hibernate-core, but is= generally included in a project as a runtime dependency. It pulls in the <= application>SwarmCache dependencies automatically. + + + +
\ No newline at end of file --===============3531717108967848000==--