Thread: [JWebUnit-development] SF.net SVN: jwebunit:[951] trunk/src/site/xdoc
Brought to you by:
henryju
Menu
▾
▴
jwebunit-development
|
From: <jev...@us...> - 2012-08-16 01:26:54
|
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>
+<configuration debug="false">
+ <!-- definition of appender STDOUT -->
+ <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+ <encoder>
+ <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
+ </encoder>
+ </appender>
+
+ <root level="ERROR">
+ <!-- appender referenced after it is defined -->
+ <appender-ref ref="STDOUT"/>
+ </root>
+</configuration>
+</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.
|
|
From: <he...@us...> - 2014-03-17 10:01:03
|
Revision: 970
http://sourceforge.net/p/jwebunit/code/970
Author: henryju
Date: 2014-03-17 10:00:59 +0000 (Mon, 17 Mar 2014)
Log Message:
-----------
Update documentation
Modified Paths:
--------------
trunk/src/site/xdoc/building-maven.xml
trunk/src/site/xdoc/how-to-contribute.xml
Modified: trunk/src/site/xdoc/building-maven.xml
===================================================================
--- trunk/src/site/xdoc/building-maven.xml 2014-03-17 09:56:31 UTC (rev 969)
+++ trunk/src/site/xdoc/building-maven.xml 2014-03-17 10:00:59 UTC (rev 970)
@@ -32,14 +32,14 @@
difficult than installing ant. We've included a best
practice installation and configuration for Maven.
</p>
- <subsection name="Installing Sun JDK 1.5">
+ <subsection name="Installing Sun JDK 1.6">
<p>
- JWebUnit is compiled with JDK 1.5 to ensure compatibility.
+ JWebUnit is compiled with JDK 1.6 to ensure compatibility.
</p>
<p>
- You need to download and install latest Sun JDK 1.5 for your platform.
- Let's say the JDK location is:
- <source>/opt/jdk1.5.0_22</source>
+ You need to download and install latest Sun JDK 1.6 for your platform.
+ Let's say the JDK location is:
+ <source>/opt/jdk1.6.0_22</source>
</p>
</subsection>
<subsection name="Installing Maven">
@@ -47,15 +47,15 @@
First you need to download the latest Maven, which
currently is
<a href="http://maven.apache.org">
- <tt>Maven-3.0</tt>
+ <tt>Maven-3.2.1</tt>
</a>
, make sure you download the binary archive
- (e.g. apache-maven-3.0-bin.tar.bz2).
+ (e.g. apache-maven-3.2.1-bin.tar.bz2).
</p>
<p>
Installing Maven should be easy: extract the file to
any directory you like, let's say:
- <source>/opt/apache-maven-3.0</source>
+ <source>/opt/apache-maven-3.2.1</source>
</p>
<p>
Next you need to do 2 things:
@@ -63,7 +63,7 @@
<li>
add an environment variable M2_HOME which
points to the install directory of Maven,
- i.e. /opt/apache-maven-3.0
+ i.e. /opt/apache-maven-3.2.1
</li>
<li>
add
@@ -79,34 +79,6 @@
<tt>mvn -v</tt>
</p>
</subsection>
- <subsection name="Configure Maven toolchains">
- <p>
- You can run Maven with any JDK (let's say JDK 1.6) but JWebUnit should be compiled
- with JDK 1.5. To achieve this we are using <a href="http://maven.apache.org/guides/mini/guide-using-toolchains.html">Maven toolchains mecanism</a>.
- </p>
- <p>
- Create a file <tt>~/.m2/toolchains.xml</tt> with the given content:
- </p>
- <source><![CDATA[
-<?xml version="1.0" encoding="UTF8"?>
-<toolchains>
- <toolchain>
- <type>jdk</type>
- <provides>
- <version>1.5</version>
- <vendor>sun</vendor>
- <id>1.5</id>
- </provides>
- <configuration>
- <jdkHome>/opt/jdk1.5.0_22</jdkHome>
- </configuration>
- </toolchain>
-</toolchains>]]>
- </source>
- <p>
- You should of course define the correct jdkHome for you.
- </p>
- </subsection>
<subsection name="Using Maven">
<p>
Maven defines several goals, for creating and
@@ -141,17 +113,17 @@
</subsection>
<subsection name="Testing JWebUnit">
<p>
- JWebUnit is supported with a suite of test cases, which
- ensure that the testing framework works as expected.
- These tests are run through Maven by running:
+ JWebUnit is supported with a suite of test cases, which
+ ensure that the testing framework works as expected.
+ These tests are run through Maven by running:
<source>mvn test</source>
</p>
</subsection>
<subsection name="Using Eclipse">
<p>
- If you are using the <a href="http://www.eclipse.org">Eclipse IDE</a>
- to develop the JWebUnit plugin,
- you can use <a href="http://m2eclipse.sonatype.org/">m2eclipse</a>.
+ If you are using the <a href="http://www.eclipse.org">Eclipse IDE</a>
+ to develop the JWebUnit plugin,
+ you can use <a href="http://m2eclipse.sonatype.org/">m2eclipse</a>.
</p>
</subsection>
<subsection name="Building Sourceforge upload bundle">
@@ -173,13 +145,6 @@
If you want to test the final assembled site, just hit:</p>
<source>mvn site:stage -DstagingDirectory=C:\fullsite</source>
<p>You can of course customize the destination folder of the assembled site.</p>
-
- <p>If it is taking a long time to build the dependencies report of each plugin,
- you can disable it by adding the following parameter (<a href="http://www.nabble.com/Skipping-dependency-report-during-Maven2-site-generation-td20116761.html">reference</a>):
- <source>-Ddependency.locations.enabled=false</source>
- This will disable the generation of dependency locations in the report and may
- reduce site generation time significantly.
- </p>
</subsection>
</section>
</body>
Modified: trunk/src/site/xdoc/how-to-contribute.xml
===================================================================
--- trunk/src/site/xdoc/how-to-contribute.xml 2014-03-17 09:56:31 UTC (rev 969)
+++ trunk/src/site/xdoc/how-to-contribute.xml 2014-03-17 10:00:59 UTC (rev 970)
@@ -54,7 +54,7 @@
First, you need to do your homeworks. Checkout latest code from trunk then try to <a href="building-maven.html">build JWebUnit with Maven</a>.
</p>
<p>
- Please subscribe to the developper mailing-list and tell me what feature you are working on.
+ Please subscribe to the developper mailing-list and tell what feature you are working on.
</p>
<p>
I will review your first contribution and if it doesn't break anything you will certainly be granted with commit rights (you need a sourceforge account for that).
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
Thanks for helping keep SourceForge clean.
X