You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@river.apache.org by si...@apache.org on 2011/01/07 11:40:03 UTC
svn commit: r782239 - in /websites/production/river: ./
content/river/building-river.html content/river/css/type-settings.css
Author: sijskes
Date: Fri Jan 7 10:40:03 2011
New Revision: 782239
Log:
Publishing merge to river site by sijskes
Modified:
websites/production/river/ (props changed)
websites/production/river/content/river/building-river.html
websites/production/river/content/river/css/type-settings.css
Propchange: websites/production/river/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jan 7 10:40:03 2011
@@ -1 +1 @@
-/websites/staging/river/trunk:778669-782182
+/websites/staging/river/trunk:778669-782238
Modified: websites/production/river/content/river/building-river.html
==============================================================================
--- websites/production/river/content/river/building-river.html (original)
+++ websites/production/river/content/river/building-river.html Fri Jan 7 10:40:03 2011
@@ -57,9 +57,16 @@
<td style="overflow: hidden;" valign="top" width="100%">
<div class="wiki-content">
<h1 id="building_river">Building River</h1>
-<p>Before you can start building River a word of warning;</p>
-<h2 id="a_note_on_paths">A note on paths</h2>
-<p>The build process does not place nicely if you have spaces in your path names. This includes the install path of the JDK.<br />
+<h2 id="prerequisites">Prerequisites</h2>
+<p>In order to build river, you need the following tools:</p>
+<ul>
+<li>Oracle JDK 1.6</li>
+<li>Apache ANT 1.8</li>
+</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>
+<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>
@@ -90,12 +97,12 @@
<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>
-<h2 id="testing_river">Testing River</h2>
+<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>
-<h3 id="the_junit_tests">The JUnit tests</h3>
+<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>
-<h3 id="the_qa_test_suite">The QA Test Suite</h3>
+<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>
@@ -114,9 +121,9 @@
</pre></div>
-<h4 id="running_just_a_few_tests">Running just a few tests</h4>
+<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>
-<h5 id="by_settings_in_the_properties_file">By settings in the properties file</h5>
+<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>
@@ -128,16 +135,16 @@
</pre></div>
-<h5 id="by_specifying_on_the_commandline">By specifying on the commandline</h5>
+<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>
<p>Existing QA tests can be found in the following path; <code>$RIVER_HOME/qa/src/com/sun/jini/test/**"</code></p>
-<h4 id="categories">Categories</h4>
+<h3 id="categories">Categories</h3>
<p>You can find the test categories on <a href="testing-categories.html">Test categories</a></p>
-<h3 id="jtreg_tests">JTREG tests</h3>
+<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>
@@ -157,9 +164,9 @@
</li>
</ul>
<p>JTREG will create the directory <code>$RIVER_HOME/qa/jtreg/JTreport</code> which contains a report of the test run.</p>
-<h4 id="running_specific_jtreg_tests">Running specific JTREG tests</h4>
+<h3 id="running_specific_jtreg_tests">Running specific JTREG tests</h3>
<p><em>todo</em></p>
-<h4 id="known_problems">Known Problems</h4>
+<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>
Modified: websites/production/river/content/river/css/type-settings.css
==============================================================================
--- websites/production/river/content/river/css/type-settings.css (original)
+++ websites/production/river/content/river/css/type-settings.css Fri Jan 7 10:40:03 2011
@@ -484,32 +484,32 @@ h1 {
border-bottom: 1px solid #808080;
padding: 2px;
margin: 36px 0px 4px -25px;
- font-size: 20px;
+/* font-size: 20px; */
}
h2 {
border-bottom: 1px solid #a0a0a0;
padding: 2px;
margin: 27px 0px 4px -20px;
- font-size: 18px;
+/* font-size: 18px; */
}
h3 {
border-bottom: 1px solid #c0c0c0;
padding: 2px;
margin: 21px 0px 4px -15px;
- font-size: 16px;
+/* font-size: 16px; */
}
h4 {
border-bottom: 1px solid #c0c0c0;
padding: 2px;
margin: 18px 0px 4px -10px;
- font-size: 15px;
+/* font-size: 15px; */
}
h4.search {
- font-size: 12px;
+/* font-size: 12px; */
line-height: normal;
font-weight: normal;
background-color: #f0f0f0;
@@ -520,13 +520,13 @@ h4.search {
h5 {
padding: 2px;
margin: 14px 0px 4px -5px;
- font-size: 14px;
+/* font-size: 14px; */
}
h6 {
padding: 2px;
margin: 14px 0px 4px -5px;
- font-size: 13px;
+/* font-size: 13px; */
}
.smallfont {