[JWebUnit-development] SF.net SVN: jwebunit:[951] trunk/src/site/xdoc

[<jev...@us...>]

Revision: 951
          http://jwebunit.svn.sourceforge.net/jwebunit/?rev=951&view=rev
Author:   jevonwright
Date:     2012-08-16 01:26:46 +0000 (Thu, 16 Aug 2012)
Log Message:
-----------
adding quickstart documentation on configuring logback

Modified Paths:
--------------
    trunk/src/site/xdoc/index.xml
    trunk/src/site/xdoc/quickstart.xml

Modified: trunk/src/site/xdoc/index.xml
===================================================================
--- trunk/src/site/xdoc/index.xml	2012-07-25 17:20:51 UTC (rev 950)
+++ trunk/src/site/xdoc/index.xml	2012-08-16 01:26:46 UTC (rev 951)
@@ -91,7 +91,8 @@
 		</source>
 		
 		For some more examples on how to use JWebUnit in your project, please look at the
-		<a href="quickstart.html">quick start guide</a>.
+		<a href="quickstart.html">quick start guide</a>. If you are having problems with
+		excessive Httpclient logging, you will also need to <a href="quickstart.html#Configuring_Logback">configure logback correctly</a>.
 			<!-- 
 			waiting on issue 2367400:
 			and the <a href="">generated WebTestCase documentation</a>.

Modified: trunk/src/site/xdoc/quickstart.xml
===================================================================
--- trunk/src/site/xdoc/quickstart.xml	2012-07-25 17:20:51 UTC (rev 950)
+++ trunk/src/site/xdoc/quickstart.xml	2012-08-16 01:26:46 UTC (rev 951)
@@ -146,6 +146,34 @@
 </p>
 </subsection>
 
+<subsection name="Configuring Logback">
+<p>
+	<a href="http://hc.apache.org/">Apache Commons' HTTP Components project</a>, one of the dependencies of JWebUnit, uses the <a href="http://logback.qos.ch/">logback logging framework</a> extensively.
+	This means that if you do not have logback correctly configured, you will get <a href="http://stackoverflow.com/questions/4915414/disable-httpclient-logging">a lot of debug information</a> piped to stdout.
+</p>
+
+<p>
+	A simple way to configure logback is to create a file called <i>logback.xml</i> with the following contents, and placing it in your source folder (for example, <i>src</i>).
+	This will suppress all debugging messages unless they are at the ERROR level or higher.
+</p>
+
+<source>
+&lt;configuration debug="false"&gt;
+  &lt;!-- definition of appender STDOUT --&gt;
+  &lt;appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"&gt;
+    &lt;encoder&gt;
+      &lt;pattern&gt;%-4relative [%thread] %-5level %logger{35} - %msg %n&lt;/pattern&gt;
+    &lt;/encoder&gt;
+  &lt;/appender&gt;
+
+  &lt;root level="ERROR"&gt;
+    &lt;!-- appender referenced after it is defined --&gt;
+    &lt;appender-ref ref="STDOUT"/&gt;
+  &lt;/root&gt; 
+&lt;/configuration&gt;
+</source>
+</subsection>
+
 <subsection name="Selecting the plugin you want to use">
 <p>
     JWebUnit can use different plugins to execute the tests you write. Only one line makes the difference:

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.