Skip to content
This repository was archived by the owner on Apr 7, 2022. It is now read-only.

Commit aa65647

Browse files
henryjuhenryju
committed
Update documentation
1 parent d452c9c commit aa65647

2 files changed

Lines changed: 16 additions & 51 deletions

File tree

‎src/site/xdoc/building-maven.xml‎

Lines changed: 15 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -32,38 +32,38 @@
3232
difficult than installing ant. We've included a best
3333
practice installation and configuration for Maven.
3434
</p>
35-
<subsection name="Installing Sun JDK 1.5">
35+
<subsection name="Installing Sun JDK 1.6">
3636
<p>
37-
JWebUnit is compiled with JDK 1.5 to ensure compatibility.
37+
JWebUnit is compiled with JDK 1.6 to ensure compatibility.
3838
</p>
3939
<p>
40-
You need to download and install latest Sun JDK 1.5 for your platform.
41-
Let's say the JDK location is:
42-
<source>/opt/jdk1.5.0_22</source>
40+
You need to download and install latest Sun JDK 1.6 for your platform.
41+
Let's say the JDK location is:
42+
<source>/opt/jdk1.6.0_22</source>
4343
</p>
4444
</subsection>
4545
<subsection name="Installing Maven">
4646
<p>
4747
First you need to download the latest Maven, which
4848
currently is
4949
<a href="http://maven.apache.org">
50-
<tt>Maven-3.0</tt>
50+
<tt>Maven-3.2.1</tt>
5151
</a>
5252
, make sure you download the binary archive
53-
(e.g. apache-maven-3.0-bin.tar.bz2).
53+
(e.g. apache-maven-3.2.1-bin.tar.bz2).
5454
</p>
5555
<p>
5656
Installing Maven should be easy: extract the file to
5757
any directory you like, let's say:
58-
<source>/opt/apache-maven-3.0</source>
58+
<source>/opt/apache-maven-3.2.1</source>
5959
</p>
6060
<p>
6161
Next you need to do 2 things:
6262
<ul>
6363
<li>
6464
add an environment variable M2_HOME which
6565
points to the install directory of Maven,
66-
i.e. /opt/apache-maven-3.0
66+
i.e. /opt/apache-maven-3.2.1
6767
</li>
6868
<li>
6969
add
@@ -79,34 +79,6 @@
7979
<tt>mvn -v</tt>
8080
</p>
8181
</subsection>
82-
<subsection name="Configure Maven toolchains">
83-
<p>
84-
You can run Maven with any JDK (let's say JDK 1.6) but JWebUnit should be compiled
85-
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>.
86-
</p>
87-
<p>
88-
Create a file <tt>~/.m2/toolchains.xml</tt> with the given content:
89-
</p>
90-
<source><![CDATA[
91-
<?xml version="1.0" encoding="UTF8"?>
92-
<toolchains>
93-
<toolchain>
94-
<type>jdk</type>
95-
<provides>
96-
<version>1.5</version>
97-
<vendor>sun</vendor>
98-
<id>1.5</id>
99-
</provides>
100-
<configuration>
101-
<jdkHome>/opt/jdk1.5.0_22</jdkHome>
102-
</configuration>
103-
</toolchain>
104-
</toolchains>]]>
105-
</source>
106-
<p>
107-
You should of course define the correct jdkHome for you.
108-
</p>
109-
</subsection>
11082
<subsection name="Using Maven">
11183
<p>
11284
Maven defines several goals, for creating and
@@ -141,17 +113,17 @@
141113
</subsection>
142114
<subsection name="Testing JWebUnit">
143115
<p>
144-
JWebUnit is supported with a suite of test cases, which
145-
ensure that the testing framework works as expected.
146-
These tests are run through Maven by running:
116+
JWebUnit is supported with a suite of test cases, which
117+
ensure that the testing framework works as expected.
118+
These tests are run through Maven by running:
147119
<source>mvn test</source>
148120
</p>
149121
</subsection>
150122
<subsection name="Using Eclipse">
151123
<p>
152-
If you are using the <a href="http://www.eclipse.org">Eclipse IDE</a>
153-
to develop the JWebUnit plugin,
154-
you can use <a href="http://m2eclipse.sonatype.org/">m2eclipse</a>.
124+
If you are using the <a href="http://www.eclipse.org">Eclipse IDE</a>
125+
to develop the JWebUnit plugin,
126+
you can use <a href="http://m2eclipse.sonatype.org/">m2eclipse</a>.
155127
</p>
156128
</subsection>
157129
<subsection name="Building Sourceforge upload bundle">
@@ -173,13 +145,6 @@
173145
If you want to test the final assembled site, just hit:</p>
174146
<source>mvn site:stage -DstagingDirectory=C:\fullsite</source>
175147
<p>You can of course customize the destination folder of the assembled site.</p>
176-
177-
<p>If it is taking a long time to build the dependencies report of each plugin,
178-
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>):
179-
<source>-Ddependency.locations.enabled=false</source>
180-
This will disable the generation of dependency locations in the report and may
181-
reduce site generation time significantly.
182-
</p>
183148
</subsection>
184149
</section>
185150
</body>

‎src/site/xdoc/how-to-contribute.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
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>.
5555
</p>
5656
<p>
57-
Please subscribe to the developper mailing-list and tell me what feature you are working on.
57+
Please subscribe to the developper mailing-list and tell what feature you are working on.
5858
</p>
5959
<p>
6060
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).

0 commit comments

Comments
 (0)