Author: ruwan
Date: Mon Nov 22 04:45:03 2010
New Revision: 1037602
URL: http://svn.apache.org/viewvc?rev=1037602&view=rev
Log:
Fixing the building page documentation
Modified:
synapse/branches/2.0/src/site/xdoc/building.xml
Modified: synapse/branches/2.0/src/site/xdoc/building.xml
URL:
http://svn.apache.org/viewvc/synapse/branches/2.0/src/site/xdoc/building.xml?rev=1037602&r1=1037601&r2=1037602&view=diff
==============================================================================
--- synapse/branches/2.0/src/site/xdoc/building.xml (original)
+++ synapse/branches/2.0/src/site/xdoc/building.xml Mon Nov 22 04:45:03 2010
@@ -5,7 +5,7 @@
<body>
<section name="Obtaining the code">
<p>
- You can obtain the code by downloading the <a class="externalLink"
href="http://ws.apache.org/synapse/download/1.2/download.cgi";>source
distribution</a> or, more commonly, checking out the source from Subversion
(SVN).
+ You can obtain the code by downloading the <a class="externalLink"
href="http://synapse.apache.org/download/2.0.0/download.cgi";>source
distribution</a> or, more commonly, checking out the source from Subversion
(SVN).
To checkout the code from <a class="externalLink"
href="http://subversion.tigris.org/";>Subversion</a>, firstly get subversion
installed, then use the following commands:
<pre>svn co http://svn.apache.org/repos/asf/synapse/trunk/java
[path-where-you-want-the-code]</pre>
If you are a committer then you need to use the secure version:
@@ -13,33 +13,27 @@
</section>
<section name="Building">
<p>
-The first thing you need to build the code is JDK1.5 and <a
class="externalLink" href="http://maven.apache.org/download/";>Maven2</a>. You
need at least version 2.0.7.
-Synapse is not yet tested on JDK1.6 or above.
+The first thing you need to build the code is JDK1.5 or JDK1.6 and <a
class="externalLink" href="http://maven.apache.org/download.html";>Maven2</a>.
Preferred version for building the code is the version 2.1.0 of Maven2.
</p>
<p>
To build, in the top level Synapse folder do:
<pre>
mvn clean install
-</pre></p>
-<p>
-To build the distribution archive packages do (the distribution archives are
created in new folder named target):
+</pre>
+This will build the distribution under the modules/distribution/target
directory. How ever to build the site you need to execute the command:
<pre>
-mvn assembly:assembly -Drelease
-</pre></p>
+mvn site:site
+</pre> which will build the complete synapse site including the API
documentation in the target/site directory</p>
</section>
<section name="Offline builds">
<p>
The first time you build Maven downloads all the required dependency jars to
your local repository,
after there has been a successful build you can add the "-o"
parameter to the above commands to run in offline mode
which avoids going out to remote Maven repositories. The result - the build
runs faster.
-<hr />
<pre>
mvn clean install -o
</pre>
-or
-<pre>
-mvn assembly:assembly -Drelease -o
-</pre></p>
+</p>
</section>
<section name="Skipping tests">
<p>
@@ -47,12 +41,9 @@ If you don't want to have all the Synaps
<pre>
mvn clean install -o -Dmaven.test.skip=true
</pre>
-or
-<pre>
-mvn assembly:assembly -Drelease -o -Dmaven.test.skip=true
-</pre></p>
+</p>
</section>
-<section name="Updating_Snapshots">
+<section name="Updating Snapshots">
<p>
Sometimes the trunk build uses snapshot versions of some dependency jars which
can go out
of date but may not get refreshed in your local Maven repository even when the
"-o" parameter is not used.
@@ -66,12 +57,15 @@ uses use a different local repository wi
mvn clean install -Dmaven.repo.local=\Synapse\MyRepo
</pre></p>
</section>
-<section name="Eclipse_Projects">
+<section name="Eclipse/IDEA Projects">
<p>
-You can create Eclipse project definitions for Synapse (that can be imported
directly into Eclipse).
+You can create Eclipse/IDEA project definitions for Synapse (that can be
imported directly into Eclipse or open with IDEA).
At the top level Synapse folder run:
<pre>
mvn eclipse:eclipse
+</pre>or
+<pre>
+mvn idea:idea
</pre>
Now within eclipse you can import those Synapse projects into an Eclipse
workspace.
From Eclipse do File -> Import, expand the "General" toggle and
choose "Existing Projects into Workspace",
