Author: hardy.ferentschik
Date: 2008-07-01 09:33:38 -0400 (Tue, 01 Jul 2008)
New Revision: 14834
Modified:
annotations/trunk/doc/reference/en/modules/setup.xml
Log:
ANN-741:
Added some documentation regarding the switch to slf4j
Modified: annotations/trunk/doc/reference/en/modules/setup.xml
===================================================================
--- annotations/trunk/doc/reference/en/modules/setup.xml 2008-07-01 10:05:16 UTC (rev 14833)
+++ annotations/trunk/doc/reference/en/modules/setup.xml 2008-07-01 13:33:38 UTC (rev 14834)
@@(protected) @@
<itemizedlist>
<listitem>
- <para>Download and unpack the Hibernate Annotations distribution from
- the Hibernate website.</para>
+ <para><ulink url="http://www.hibernate.org/6.html">Download</ulink>
+ and unpack the Hibernate Annotations distribution from the Hibernate
+ website.</para>
</listitem>
<listitem>
- <para><emphasis>This release requires Hibernate Core 3.3 and above.</emphasis></para>
+ <para><emphasis>This release requires Hibernate Core 3.3 and
+ above.</emphasis></para>
</listitem>
<listitem>
@@(protected) @@
</listitem>
</itemizedlist></para>
- <para>If you wish to use Hibernate Validator (TODO make a link to HV doc),
- download it from the Hibernate website and add
+ <para>If you wish to use <ulink
+ url="http://validator.hibernate.org">Hibernate Validator</ulink>, download
+ it from the Hibernate website and add
<filename>hibernate-validator.jar</filename> in your classpath.</para>
- <para>If you wish to use Hibernate Search (TODO make a link to HSearch
- doc), download it from the Hibernate website and add
+ <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.</para>
@@(protected) @@
<para>Asides from the Hibernate core properties, Hibernate Annotations
reacts to the following one</para>
+ </section>
+ <section>
+ <title>Logging</title>
+
+ <para>Hibernate Annotations utlizes <ulink
+ url="http://www.slf4j.org/">Simple Logging Facade for Java</ulink> (SLF4J)
+ in order to log various system events. SLF4J can direct your logging
+ output to several logging frameworks (NOP, Simple, log4j version 1.2, JDK
+ 1.4 logging, JCL or logback) depending on your chosen binding. In order to
+ setup logging properly you will need <filename>slf4j-api.jar</filename> in
+ your classpath together with the jar file for your preferred binding -
+ <filename>slf4j-log4j12.jar</filename> in the case of Log4J. See the SLF4J
+ <ulink type=""
+ url="http://www.slf4j.org/manual.html">documentation</ulink> for more
+ detail.</para>
+
+ <para>The logging categories interesting for Hibernate Annotations
+ are:</para>
+
<table>
- <title>List of properties</title>
+ <title>Hibernate Annotations Log Categories</title>
<tgroup cols="2">
<thead>
<row>
- <entry align="center">Property</entry>
+ <entry align="center">Category</entry>
- <entry align="center">Definition</entry>
+ <entry align="center">Function</entry>
</row>
</thead>
<tbody>
<row>
- <entry>hibernate.validator.apply_to_ddl</entry>
+ <entry><emphasis>org.hibernate.cfg</emphasis></entry>
- <entry>Use Hibernate Validator annotations to refine the database
- schema generation. Default to true.</entry>
+ <entry>Log all configuration related events (not only
+ annotations).</entry>
</row>
-
- <row>
- <entry></entry>
-
- <entry></entry>
- </row>
</tbody>
</tgroup>
</table>
+
+ <para>For further category configuration refer to the <ulink
+ 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
_______________________________________________
hibernate-commits mailing list
hibernate-commits@(protected)
https://lists.jboss.org/mailman/listinfo/hibernate-commits
