You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@river.apache.org by bu...@apache.org on 2012/05/31 11:05:59 UTC
svn commit: r819727 - in /websites/staging/river/trunk/content: ./
building-river.html
Author: buildbot
Date: Thu May 31 09:05:59 2012
New Revision: 819727
Log:
Staging update by buildbot for river
Modified:
websites/staging/river/trunk/content/ (props changed)
websites/staging/river/trunk/content/building-river.html
Propchange: websites/staging/river/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu May 31 09:05:59 2012
@@ -1 +1 @@
-1329330
+1344608
Modified: websites/staging/river/trunk/content/building-river.html
==============================================================================
--- websites/staging/river/trunk/content/building-river.html (original)
+++ websites/staging/river/trunk/content/building-river.html Thu May 31 09:05:59 2012
@@ -66,7 +66,7 @@
<tr>
<td style="overflow: hidden;" valign="top" width="100%">
<div class="wiki-content">
-<h1 id="building_river">Building River</h1>
+<h1 id="building-river">Building River</h1>
<h2 id="prerequisites">Prerequisites</h2>
<p>In order to build river, you need the following tools:</p>
<ul>
@@ -75,18 +75,18 @@
</ul>
<p>The rest is included in the source archive, and in the SVN.</p>
<p>This article also describes how to setup your IDE to compile River.</p>
-<h2 id="warning_spaces_in_paths">(warning) Spaces in paths</h2>
+<h2 id="warning-spaces-in-paths">(warning) Spaces in paths</h2>
<p>The build process does not play nicely if you have spaces in your path names. This includes the install path of the JDK.<br />
</p>
<p>This can be circumvented, at least on a Windows/Cygwin by using the first 6 characters of the name with a space in, and postfixing a tilde and the number 1.</p>
<p>For example; <code>C:\Program Files</code> would become; <code>C:\Progra~1</code></p>
-<p>If the first six characters of your path name are not a unique name, for example if you have the two paths "C:Program Files" and "C:Program Something Else" then the number after the tilde may well be different. It is suggested that you experiment using the Windows command shell to establish the correct 'tilde plus number' name for your path.</p>
+<p>If the first six characters of your path name are not a unique name, for example if you have the two paths "C:\Program Files" and "C:\Program Something Else" then the number after the tilde may well be different. It is suggested that you experiment using the Windows command shell to establish the correct 'tilde plus number' name for your path.</p>
<p>So Windows users please be particular aware.<br />
</p>
<p>If you are running on Windows, it is also advisable to use a forward slash '/' are the path separator. This is acceptable to both Java and Ant, and has the added benefit that the paths will be correct if you decide to run the JTREG tests (some of which require a Unix-like/Cygwin environment to run scripts in). This is particularly important for the <code>river.home</code> property which is inherited from in the <code>qa/build.xml</code> file and subsequently passed onto the various classes which make up the jtreg tests.</p>
-<h2 id="check_out_the_code">Check out the code</h2>
+<h2 id="check-out-the-code">Check out the code</h2>
<p>See <a href="source-code.html">this page</a> on how to check out the source code.</p>
-<h2 id="build_the_distribution">Build the distribution</h2>
+<h2 id="build-the-distribution">Build the distribution</h2>
<p>River can be built simply by running Ant from where you checked the code out from.</p>
<p>Assume "$RIVER_HOME" is where you have checked out the code to.</p>
<div class="codehilite"><pre><span class="n">cd</span> <span class="nv">$RIVER_HOME</span>
@@ -95,7 +95,7 @@
<p>Will build all the River JARs required. You will then find them in the ${RIVER_HOME}/lib* directories.</p>
-<h2 id="setting_up_the_ide">Setting up the IDE</h2>
+<h2 id="setting-up-the-ide">Setting up the IDE</h2>
<h3 id="eclipse">Eclipse</h3>
<p>Create your new IDE project using your prefered method (e.g. "Import from SVN" or create a new project using existing source, etc).<br />
</p>
@@ -107,13 +107,14 @@ Currently, River should be built with JD
</p>
<p>That should everything that Eclipse needs to be happy with the River code.</p>
<h3 id="netbeans">NetBeans</h3>
-<p><em>TODO</em></p>
-<h1 id="testing_river">Testing River</h1>
+<p>Checkout the trunk.</p>
+<p>Within Netbeans 7.1 do: Open Project ; Navigate to the netbeans directory ; Open the onebigjar project.</p>
+<h1 id="testing-river">Testing River</h1>
<p>This build process runs the (limited) suite of unit tests that comes with River. River is tested predominantly by using <a href="http://openjdk.java.net/jtreg/">jtreg</a> and the QA test suite.</p>
-<h2 id="the_junit_tests">The JUnit tests</h2>
+<h2 id="the-junit-tests">The JUnit tests</h2>
<p>The JUnit tests can be found in <code>$RIVER_HOME/test/src</code> you must also add the JARs found in <code>$RIVER_HOME/test/lib</code> onto the classpath for your tests.</p>
<p>It's easiest to run these tests from your IDE. In Eclipse, for example, once <code>$RIVER_HOME/test/src</code> is set at the test source directory, right-clicking the project and hitting "Run as JUnit test" is all that is required.</p>
-<h2 id="the_qa_test_suite">The QA Test Suite</h2>
+<h2 id="the-qa-test-suite">The QA Test Suite</h2>
<p>The QA tests can also be run from the Ant script. You must make sure the Ant you are using is using the correct JDK. You can run "ant diagnostics" in the project directory to find out which JVM Ant is using.</p>
<p>Make sure that you have the following in your build.properties file which you will need to create in <code>$RIVER_HOME</code>.</p>
<div class="codehilite"><pre><span class="n">river</span><span class="o">.</span><span class="n">home</span><span class="o">=</span><span class="nv">$RIVER_HOME</span>
@@ -124,7 +125,7 @@ Currently, River should be built with JD
<blockquote>
-<p>Please note the remark above about using paths which contains spaces and the use of '/' over ''.</p>
+<p>Please note the remark above about using paths which contains spaces and the use of '/' over '\'.</p>
</blockquote>
<p>Execute the following:</p>
<div class="codehilite"><pre><span class="n">cd</span> <span class="nv">$RIVER_HOME</span>
@@ -132,9 +133,9 @@ Currently, River should be built with JD
</pre></div>
-<h3 id="running_just_a_few_tests">Running just a few tests</h3>
+<h3 id="running-just-a-few-tests">Running just a few tests</h3>
<p>Running the entire QA suite tasks a significant portion of time; currently around the 17 hour mark. It is therefore useful to be able to specify a subset of categories or even specific tests to run. </p>
-<h4 id="by_settings_in_the_properties_file">By settings in the properties file</h4>
+<h4 id="by-settings-in-the-properties-file">By settings in the properties file</h4>
<p>When running the QA tests with Ant, this is done by including the following in the Ant build.properties file.</p>
<div class="codehilite"><pre><span class="c1"># runs a specified category</span>
<span class="c1"># e.g. run.categories=lookupservice</span>
@@ -146,7 +147,7 @@ Currently, River should be built with JD
</pre></div>
-<h4 id="by_specifying_on_the_commandline">By specifying on the commandline</h4>
+<h4 id="by-specifying-on-the-commandline">By specifying on the commandline</h4>
<p>From the qa directory:</p>
<div class="codehilite"><pre><span class="n">ant</span> <span class="o">-</span><span class="n">Drun</span><span class="o">.</span><span class="n">tests</span><span class="o">=</span><span class="n">com</span><span class="sr">/sun/</span><span class="n">jini</span><span class="sr">/test/s</span><span class="n">pec</span><span class="sr">/constraint/co</span><span class="n">reconstraint</span><span class="o">/</span><span class="n">PrincipalElementsTest</span><span class="o">.</span><span class="n">td</span> <span class="n">run</span><span class="o">-</span><span class="n">tests</span>
</pre></div>
@@ -155,7 +156,7 @@ Currently, River should be built with JD
<p>Existing QA tests can be found in the following path; <code>$RIVER_HOME/qa/src/com/sun/jini/test/**"</code></p>
<h3 id="categories">Categories</h3>
<p>You can find the test categories on <a href="testing-categories.html">Test categories</a></p>
-<h2 id="jtreg_tests">JTREG tests</h2>
+<h2 id="jtreg-tests">JTREG tests</h2>
<p>You must first download and install jtreg following the instructions on their site.</p>
<p>Some of these tests are run as BASH scripts, therefore, if running the jtreg tests on Windows a Cygwin (or similar) environment is necessary.</p>
<p>The JTREG tests can then be run by execute the following:</p>
@@ -175,9 +176,9 @@ Currently, River should be built with JD
</li>
</ul>
<p>JTREG will create the directory <code>$RIVER_HOME/qa/jtreg/JTreport</code> which contains a report of the test run.</p>
-<h3 id="running_specific_jtreg_tests">Running specific JTREG tests</h3>
+<h3 id="running-specific-jtreg-tests">Running specific JTREG tests</h3>
<p><em>todo</em></p>
-<h3 id="known_problems">Known Problems</h3>
+<h3 id="known-problems">Known Problems</h3>
<p>There are the following known problems with the jtreg tests:</p>
<ol>
<li>Running the tests in a Windows/Cygwin environment is not 100% working yet</li>
@@ -191,7 +192,7 @@ Currently, River should be built with JD
<div class="navigation_top">
<div class="navigation_bottom">
<!-- sidenav -->
-<h3 id="the_foundation">The Foundation</h3>
+<h3 id="the-foundation">The Foundation</h3>
<ul>
<li><a href="http://www.apache.org">Apache</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -199,7 +200,7 @@ Currently, River should be built with JD
<li><a href="http://www.apache.org/security/">Security</a></li>
<li><a href="http://www.apache.org/foundation/how-it-works.html">How it works</a></li>
</ul>
-<h3 id="apache_river">Apache river</h3>
+<h3 id="apache-river">Apache river</h3>
<ul>
<li><a href="downloads.html">Downloads</a></li>
<li><a href="http://www.apache.org/licenses/">License</a></li>
@@ -245,15 +246,14 @@ Currently, River should be built with JD
<li><a href="http://wiki.apache.org/river/">Wiki</a></li>
</ul>
<h3 id="search">Search</h3>
-<DIV>
+<p><DIV>
<form method="get" action="http://www.google.com/search" id="search" name="search" style="font-size: 10px;">
<input type="hidden" name="sitesearch" value="river.apache.org">
<input type="text" id="query" name="q" size="15" maxlength="255" >
<BR/>
<input type="submit" value="Search" id="submit"/>
</form>
-</DIV>
-
+</DIV></p>
<ul>
<li><a href="sitemap.html">Sitemap</a></li>
</ul>