Switched documentation to xhtml, to be able to integrate google-pretty-print
[hibernate4-maven-plugin] / src / site / xhtml / debugging.xhtml
diff --git a/src/site/xhtml/debugging.xhtml b/src/site/xhtml/debugging.xhtml
new file mode 100644 (file)
index 0000000..8f91f3f
--- /dev/null
@@ -0,0 +1,30 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ </head>
+ <body>
+  <p>
+  If you are new to <code>hibernate4-maven-plugin</code>, in many cases, the
+  {Configuration-Method-Precedence} may be the source of configuration
+  errors.
+  To solve this problem, you should run maven with the debugging output
+  enabled.
+  For example, by executing:
+  </p>
+  <pre class="prettyprint linenums lang-html">
+mvn -X compile hibernate4:export</pre>
+  <p>
+  (The <code>compile</code> might be necessary, because <code>hibernate4-maven-plugin</code>
+  has to scan the compiled classes for annotations!)
+  </p>
+  <p>
+  Unlike the majority of the maven-plugins, <code>hibernate4-maven-plugin</code> was
+  designed to give a good many hints, when debugging is enabled.
+  Because, if you do not know, what went wrong, you can't fix it!
+  </p>
+  <p>
+  <strong>But be warned:</strong> <code>hibernate4-maven-plugin</code> tends to be very chatty ;)
+  </p>
+ </body>
+</html>