harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hinde...@apache.org
Subject svn commit: r451271 [7/9] - in /incubator/harmony/standard/site: ./ docs/ docs/documentation/ docs/images/ docs/subcomponents/buildtest/ docs/subcomponents/classlibrary/ docs/subcomponents/drlvm/ docs/subcomponents/jchevm/ docs/subcomponents/stresstest...
Date Fri, 29 Sep 2006 12:55:29 GMT
Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/build_classlib.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/build_classlib.xml?view=diff&rev=451271&r1=451270&r2=451271
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/build_classlib.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/build_classlib.xml Fri Sep 29 05:55:25 2006
@@ -1,171 +1,171 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!--
-
-    Copyright 2006 The Apache Software Foundation
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
--->
-
-<document>
-
- <properties>
-  <title>Building the Apache Harmony Classlib</title>
-  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
- </properties>
-
-<body>
-
-<section name="Building the Apache Harmony Class Library">
-	<p>
-		The Harmony class library code is a subset of the Java(tm) SE 1.5 APIs currently
-		being developed in the <a href="http://incubator.apache.org/harmony/">
-		Apache Harmony project</a>. This page describes how to build the class library code,
-		and includes links to pre-built versions of the code.
-	</p>
-	<p>
-		<i>Standard Disclaimer:</i>
-		Apache Harmony is an effort undergoing incubation at the Apache Software
-		Foundation (ASF). Incubation is required of all newly accepted projects until
-		a further review indicates that the infrastructure, communications, and
-		decision making process have stabilized in a manner consistent with other
-		successful ASF projects. While incubation status is not necessarily a
-		reflection of the completeness or stability of the code, it does indicate
-		that the project has yet to be fully endorsed by the ASF. 
-	</p>
-
-<subsection name="Building from source">
-	<p>
-		The Harmony class library code is available for Microsoft(tm) Windows(tm) and
-		Linux(tm) operating systems, on x86 processors only.
-	</p>
-	<p>
-		The following prerequisite tools must be available on the path in order to build
-		the Harmony classlib code from source.
-		<ul>
-			<li>All platforms require Subversion client, Apache Ant, Java 1.5 JDK
-				(i.e. including javac) in addition
-				<ul>
-	    			<li>Windows platforms : Microsoft Visual C++, and nmake. </li>
-	    			<li>Linux platforms : Gnu gcc, and Gnu make.</li>
-	    		</ul>
-		    </li>
-		</ul>
-
-        <i><b>Please Note :</b></i> Please use <a href="http://ant.apache.org">Ant</a>
-        version 1.6.5 or later - earlier versions
-        (ex. 1.6.2) have been reported to handle the .svn directory incorractly, resulting
-        in double-scanning file systems during build.
-
-    </p>
-	<p>
-		You can build the latest version of the class library code in three simple steps:
-		<ol>
-			<li>Download classlib source from Harmony subversion repository
-			<pre>svn checkout -r HEAD https://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib/trunk Harmony</pre>
-			</li>
-			<li>Change to top-level classlib directory, and run the default ant script target
-			<pre>cd Harmony
-ant</pre>
-			</li>
-			<li><a href="#Obtaining_a_VM">Get a VM suitable for running the class library
-				code</a>, and
-				expand it over the top of the Harmony directory (so that the 'jdk'
-				directories line-up)
-			<pre>unzip &lt;path_to_vm_zip&gt; -d ../.. (on Windows)</pre>
-			<pre>tar xzf &lt;path_to_vm_tarball&gt; --directory ../.. (on Linux)</pre>
-			</li>
-		</ol>
-	</p>
-	<p>
-		Now you are ready to <a href="#Running_Java">run some Java applications</a>!
-	</p>
-</subsection>
-
-<subsection name="Using pre-built binaries">
-	<p>
-		Pre-built binaries are available as a convenience for people who don't
-		have ready access to the prerequisite tools.
-	</p>
-	<p>
-		These are <i>snapshot</i> builds, not official releases of the project.
-		Snapshots are builds of the repository at a given revision.  The file
-		name of each snapshot build indicates the revision of the code repository,
-		and the platform on which it was built.
-	</p>
-	<p>
-		You can use a pre-built binaries in three easy steps:
-		<ol>
-			<li>Obtain a pre-built class library snapshot for your platform from the
-				<a href="http://cvs.apache.org/dist/incubator/harmony/snapshots/">
-				Harmony snapshot site</a>.</li>
-			<li><a href="#Obtaining_a_VM">Obtain a compatible virtual machine</a> and
-				put it into the same directory as the class library code.</li>
-   			<li>Simply expand the classlib archive and the VM archive from the
-   				same directory. They should create a subdirectory called &quot;Harmony&quot;
-   				with files from each archive overlaid (so that the
-   				'Harmony/deploy/jdk'-s line-up).</li>
-   				On Windows:
-   				<pre>unzip &lt;path_to_classlib_zip&gt; (on Windows)
-unzip &lt;path_to_vm_zip&gt;</pre>
-				On Linux:
-				<pre>tar xzf &lt;path_to_classlib_tarball&gt; (on Linux)
-tar xzf &lt;path_to_vm_tarball&gt;</pre>
-		</ol>
-	</p>
-	<p>
-		Now you are ready to <a href="#Running_Java">run some Java applications</a>!
-	</p>
-</subsection>
-
-
-<subsection name="Obtaining a compatible VM">
-<a name="Obtaining_a_VM"/>
-	<p>
-		The Harmony class library code interfaces to a VM through a virtual machine interface
-		defined in the Harmony project.
-	</p>
-	<p>
-		There is a VM that implements this interface available from the
-		<a href="http://www-128.ibm.com/developerworks/java/jdk/harmony/index.html">
-		IBM DeveloperWorks site</a>.
-		<em>The IBM VM is not open source</em> (although the VM interface itself is).
-	</p>
-	<p>
-		Once you have obtained the IBM VM you should have one of the following files:
-		<ul>
-			<li>on Windows &quot;Harmony-vme-win.IA32-v4.zip&quot;</li>
-			<li>on Linux &quot;Harmony-vme-linux.IA32-v4.tar.gz&quot;</li>
-		</ul>
-	</p>
-</subsection>
-
-<subsection name="Running Java applications">
-<a name="Running_Java"/>
-	<p>
-		Ensure that the <code>JAVA_HOME</code> environment variable is unset, or pointing
-		to the <code>Harmony/deploy/jdk/jre</code> directory.
-	</p>
-	<p>
-		Run Java applications as usual, using the launcher in Harmony/deploy/jdk/jre/bin:
-		<pre>> jre\bin\java -showversion -jar helloworld.jar
-java version 1.5 (subset)
-(c) Copyright 1991, 2006 The Apache Software Foundation or its licensors, as applicable.
-Hello world!
-</pre>
-	</p>
-</subsection>
-
-</section>
-</body>
-</document>
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+    Copyright 2006 The Apache Software Foundation
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+
+ <properties>
+  <title>Building the Apache Harmony Classlib</title>
+  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+<body>
+
+<section name="Building the Apache Harmony Class Library">
+	<p>
+		The Harmony class library code is a subset of the Java(tm) SE 1.5 APIs currently
+		being developed in the <a href="http://incubator.apache.org/harmony/">
+		Apache Harmony project</a>. This page describes how to build the class library code,
+		and includes links to pre-built versions of the code.
+	</p>
+	<p>
+		<i>Standard Disclaimer:</i>
+		Apache Harmony is an effort undergoing incubation at the Apache Software
+		Foundation (ASF). Incubation is required of all newly accepted projects until
+		a further review indicates that the infrastructure, communications, and
+		decision making process have stabilized in a manner consistent with other
+		successful ASF projects. While incubation status is not necessarily a
+		reflection of the completeness or stability of the code, it does indicate
+		that the project has yet to be fully endorsed by the ASF. 
+	</p>
+
+<subsection name="Building from source">
+	<p>
+		The Harmony class library code is available for Microsoft(tm) Windows(tm) and
+		Linux(tm) operating systems, on x86 processors only.
+	</p>
+	<p>
+		The following prerequisite tools must be available on the path in order to build
+		the Harmony classlib code from source.
+		<ul>
+			<li>All platforms require Subversion client, Apache Ant, Java 1.5 JDK
+				(i.e. including javac) in addition
+				<ul>
+	    			<li>Windows platforms : Microsoft Visual C++, and nmake. </li>
+	    			<li>Linux platforms : Gnu gcc, and Gnu make.</li>
+	    		</ul>
+		    </li>
+		</ul>
+
+        <i><b>Please Note :</b></i> Please use <a href="http://ant.apache.org">Ant</a>
+        version 1.6.5 or later - earlier versions
+        (ex. 1.6.2) have been reported to handle the .svn directory incorractly, resulting
+        in double-scanning file systems during build.
+
+    </p>
+	<p>
+		You can build the latest version of the class library code in three simple steps:
+		<ol>
+			<li>Download classlib source from Harmony subversion repository
+			<pre>svn checkout -r HEAD https://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib/trunk Harmony</pre>
+			</li>
+			<li>Change to top-level classlib directory, and run the default ant script target
+			<pre>cd Harmony
+ant</pre>
+			</li>
+			<li><a href="#Obtaining_a_VM">Get a VM suitable for running the class library
+				code</a>, and
+				expand it over the top of the Harmony directory (so that the 'jdk'
+				directories line-up)
+			<pre>unzip &lt;path_to_vm_zip&gt; -d ../.. (on Windows)</pre>
+			<pre>tar xzf &lt;path_to_vm_tarball&gt; --directory ../.. (on Linux)</pre>
+			</li>
+		</ol>
+	</p>
+	<p>
+		Now you are ready to <a href="#Running_Java">run some Java applications</a>!
+	</p>
+</subsection>
+
+<subsection name="Using pre-built binaries">
+	<p>
+		Pre-built binaries are available as a convenience for people who don't
+		have ready access to the prerequisite tools.
+	</p>
+	<p>
+		These are <i>snapshot</i> builds, not official releases of the project.
+		Snapshots are builds of the repository at a given revision.  The file
+		name of each snapshot build indicates the revision of the code repository,
+		and the platform on which it was built.
+	</p>
+	<p>
+		You can use a pre-built binaries in three easy steps:
+		<ol>
+			<li>Obtain a pre-built class library snapshot for your platform from the
+				<a href="http://cvs.apache.org/dist/incubator/harmony/snapshots/">
+				Harmony snapshot site</a>.</li>
+			<li><a href="#Obtaining_a_VM">Obtain a compatible virtual machine</a> and
+				put it into the same directory as the class library code.</li>
+   			<li>Simply expand the classlib archive and the VM archive from the
+   				same directory. They should create a subdirectory called &quot;Harmony&quot;
+   				with files from each archive overlaid (so that the
+   				'Harmony/deploy/jdk'-s line-up).</li>
+   				On Windows:
+   				<pre>unzip &lt;path_to_classlib_zip&gt; (on Windows)
+unzip &lt;path_to_vm_zip&gt;</pre>
+				On Linux:
+				<pre>tar xzf &lt;path_to_classlib_tarball&gt; (on Linux)
+tar xzf &lt;path_to_vm_tarball&gt;</pre>
+		</ol>
+	</p>
+	<p>
+		Now you are ready to <a href="#Running_Java">run some Java applications</a>!
+	</p>
+</subsection>
+
+
+<subsection name="Obtaining a compatible VM">
+<a name="Obtaining_a_VM"/>
+	<p>
+		The Harmony class library code interfaces to a VM through a virtual machine interface
+		defined in the Harmony project.
+	</p>
+	<p>
+		There is a VM that implements this interface available from the
+		<a href="http://www-128.ibm.com/developerworks/java/jdk/harmony/index.html">
+		IBM DeveloperWorks site</a>.
+		<em>The IBM VM is not open source</em> (although the VM interface itself is).
+	</p>
+	<p>
+		Once you have obtained the IBM VM you should have one of the following files:
+		<ul>
+			<li>on Windows &quot;Harmony-vme-win.IA32-v4.zip&quot;</li>
+			<li>on Linux &quot;Harmony-vme-linux.IA32-v4.tar.gz&quot;</li>
+		</ul>
+	</p>
+</subsection>
+
+<subsection name="Running Java applications">
+<a name="Running_Java"/>
+	<p>
+		Ensure that the <code>JAVA_HOME</code> environment variable is unset, or pointing
+		to the <code>Harmony/deploy/jdk/jre</code> directory.
+	</p>
+	<p>
+		Run Java applications as usual, using the launcher in Harmony/deploy/jdk/jre/bin:
+		<pre>> jre\bin\java -showversion -jar helloworld.jar
+java version 1.5 (subset)
+(c) Copyright 1991, 2006 The Apache Software Foundation or its licensors, as applicable.
+Hello world!
+</pre>
+	</p>
+</subsection>
+
+</section>
+</body>
+</document>

Propchange: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/build_classlib.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse.xml?view=diff&rev=451271&r1=451270&r2=451271
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse.xml Fri Sep 29 05:55:25 2006
@@ -1,179 +1,179 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!--
-
-    Copyright 2006 The Apache Software Foundation
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
--->
-
-<document>
-
- <properties>
-  <title>Apache Harmony development using Eclipse</title>
-  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
- </properties>
-
-<body>
-<section name="Introduction">
-	<p>
-		These instructions will help you set up Eclipse to develop Java code
-		in Apache Harmony.
-	</p>
-	<p>
-		There are two sets of instructions -- the <a href="#fastpath">fast path</a>
-		for people who are
-		already familiar with Eclipse and the source code layout in Harmony's
-		Subversion repository; and the
-		<a href="#step_guide">step-by-step guide</a>
-		for people who want to follow the details of a set-up, and see a brief
-		development example.
-	</p>
-	<p>
-		Both sets of instructions assume you satisfy the same Eclipse-based
-		development <a href="#prerequisites">prerequsities</a>.
-	</p>
-
-	<subsection name="Am I eligible?">
-		<p>
-			You may have heard or read about Harmony's strict rules for contributor's
-			eligibility.  We take this seriously because a number of parties implement
-			Java, and we respect their rights to their property.  If you have detailed
-			knowledge of another implementation of Java, and they have not explicitly
-			approved your participation in Harmony, please check whether we will be able
-			to accept your contribution by reading the
-			<a href="../../contribution_policy">Apache Harmony contribution policy</a>.
-		</p>
-	</subsection>
-</section>
-
-<section name="Prerequisites for developing Apache Harmony class library code with Eclipse">
-<a name="prerequisites"/>
-	<p>
-		To develop the class library Java code with Eclipse JDT you will need:
-		<ol>
-			<li>Eclipse : version 3.2 integration build I20060119 or later, from
-			<a href="http://download.eclipse.org">eclipse.org</a></li>
-			<li>Subclipse : Subversion plug-in from <a href="http://subclipse.tigris.org/">
-			tigris.org</a></li>
-			<li>a snapshot classlib build : from the
-			<a href="http://cvs.apache.org/dist/incubator/harmony/snapshots/">
-			download page</a>.  If you prefer to build a snapshot yourself the
-			instructions are <a href="build_classlib.html">here</a>.</li>
-			<li>a compatible VM : obtain a VM as
-			<a href="build_classlib.html#Obtaining_a_VM">described here</a> capable
-			of running the class libary code, and install it in the same location as
-			the snapshot.</li>
-		</ol>
-	</p>
-</section>
-
-<section name="Fast path - for experienced Eclipse developers">
-<a name="fastpath"/>
-	<p>
-		If you know your way around Eclipse JDT, then following these steps will
-		have you hacking Harmony Java code in no time at all!
-	</p>
-
-<subsection name="Configuring Eclipse">
-	<p>
-		Ensure that you have <a href="#prerequisites">the development pre-requisites</a>
-		in place, then:
-		<ol>
-			<li>Launch Eclipse with the VM argument &quot;<code>-Dpde.jreProfile=none</code>&quot;
-				(i.e. <code>eclipse -vmargs -Dpde.jreProfile=none</code>).</li>
-			<li>Configure the following settings in <code>Window &gt; Preferences...</code>
-				<ul>
-					<li>Change the Java compiler settings
-						<ol>
-							<li>In the <code>Java &gt; Compiler</code> preferences ensure the
-								&quot;<code>Compiler compliance level</code>&quot; is set to
-								<code>1.4</code>.</li>
-							<li>In the <code>Java &gt; Compiler &gt; Building</code> preferences,
-								open the &quot;<code>Build Path Problems</code>&quot; section
-								and change &quot;<code>Circular Dependencies</code>&quot; from
-								<code>Error</code> to <code>Warning</code>.</li>
-						</ol></li>
-					<li>Change the PDE settings
-						<ol>
-							<li>In the <code>Plug-in Development &gt; Compilers</code> preferences
-								change &quot;<code>Unresolved Dependencies</code>&quot; from
-								<code>Error</code> to <code>Warning</code>.</li>
-							<li>In the <code>Plug-in Development &gt; Target Platform</code>
-								preferences, change the &quot;Location:&quot; box to be the
-								<code>jre/lib/boot</code> directory of the classlib snapshot.</li>
-						</ol></li>
-				</ul></li>
-			<li>Create a SVN repository location to the Harmony classlib, using URL
-				<code>https://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib</code></li>
-		</ol>
-	</p>
-</subsection>
-
-<subsection name="Develop and test code">
-	<p>
-		The Apache Harmony class library is structured to allow developers to work on individual
-		<em>modules</em> in the class library without having to load and compile the entire
-		project source tree.
-	</p>
-	<p>
-		This is best illustrated by a worked example.  In this example, assume you want to make
-		a change to the <code>NIO</code> module.  This is how you would proceed:
-		<ol>
-			<li>Go to the SVN repository view, open the Harmony URL and browse to
-				&quot;<code>trunk &gt; modules</code>&quot;.  Select
-				&quot;<code>nio</code>&quot; and from the context menu select
-				<code>Checkout...</code>, and on the checkout dialog just
-				click &quot;<code>Finish</code>&quot;</li>
-			<li>In the resulting project in your workspace the implementation code
-				is in the source folder <code>src/main/java</code> and the unit tests
-				are in the source folder <code>src/test/java</code>.</li>
-			<li>Hack away!  Developers are encouraged to produce JUnit tests for new
-				implementation code.</li>
-			<li>To test the code you need to set-up a JUnit Run Configuration for the
-				unit test.  You can either run a single test case, or run the
-				<code>AllTests</code> suite for all tests in a package or module.
-				For example, to run the test suite
-				<code>org.apache.harmony.tests.nio.AllTests</code> set up a
-				run configuration with the following characteristics:
-				<ul>
-					<li><em>bootclasspath</em> : the folder nio/bin/main, followed by
-						the Harmony JRE library.</li>
-					<li><em>classpath</em> : the folder nio/bin/test, followed by the
-						JUNIT JAR file.</li>
-					<br/>
-					<img src="../../images/dev_eclipse_runconf.jpg" alt="Java run configuration"/>
-					<li><em>VM</em> : the Harmony JRE as the launching VM.</li>
-				</ul>
-			</li>
-			<li>If everything looks good, go ahead and
-				<a href="../../get-involved.html#create_patch">contribute a patch</a>.</li>
-		</ol>
-	</p>
-</subsection>
-</section>
-
-<section name="Step-by-step guide to Eclipse-based development">
-<a name="step_guide"/>
-	<p>
-		We have produced a brief webcast for those who want to see a step-by-step guide
-		to configuring Eclipse, and developing a patch to the classlibrary code.  The webcast
-		starts assuming you have already installed the pre-requisities for Eclipse-based
-		development, and launched Eclipse with the following commandline:
-		<pre>eclipse -vmargs -Dpde.jreProfile=none</pre>
-		We <a href="dev_eclipse_movie.html">pick up the story here...</a> (<em>Warning 8Mb flash download!</em>)
-	</p>
-</section>
-
-</body>
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+    Copyright 2006 The Apache Software Foundation
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+
+ <properties>
+  <title>Apache Harmony development using Eclipse</title>
+  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+<body>
+<section name="Introduction">
+	<p>
+		These instructions will help you set up Eclipse to develop Java code
+		in Apache Harmony.
+	</p>
+	<p>
+		There are two sets of instructions -- the <a href="#fastpath">fast path</a>
+		for people who are
+		already familiar with Eclipse and the source code layout in Harmony's
+		Subversion repository; and the
+		<a href="#step_guide">step-by-step guide</a>
+		for people who want to follow the details of a set-up, and see a brief
+		development example.
+	</p>
+	<p>
+		Both sets of instructions assume you satisfy the same Eclipse-based
+		development <a href="#prerequisites">prerequsities</a>.
+	</p>
+
+	<subsection name="Am I eligible?">
+		<p>
+			You may have heard or read about Harmony's strict rules for contributor's
+			eligibility.  We take this seriously because a number of parties implement
+			Java, and we respect their rights to their property.  If you have detailed
+			knowledge of another implementation of Java, and they have not explicitly
+			approved your participation in Harmony, please check whether we will be able
+			to accept your contribution by reading the
+			<a href="../../contribution_policy">Apache Harmony contribution policy</a>.
+		</p>
+	</subsection>
+</section>
+
+<section name="Prerequisites for developing Apache Harmony class library code with Eclipse">
+<a name="prerequisites"/>
+	<p>
+		To develop the class library Java code with Eclipse JDT you will need:
+		<ol>
+			<li>Eclipse : version 3.2 integration build I20060119 or later, from
+			<a href="http://download.eclipse.org">eclipse.org</a></li>
+			<li>Subclipse : Subversion plug-in from <a href="http://subclipse.tigris.org/">
+			tigris.org</a></li>
+			<li>a snapshot classlib build : from the
+			<a href="http://cvs.apache.org/dist/incubator/harmony/snapshots/">
+			download page</a>.  If you prefer to build a snapshot yourself the
+			instructions are <a href="build_classlib.html">here</a>.</li>
+			<li>a compatible VM : obtain a VM as
+			<a href="build_classlib.html#Obtaining_a_VM">described here</a> capable
+			of running the class libary code, and install it in the same location as
+			the snapshot.</li>
+		</ol>
+	</p>
+</section>
+
+<section name="Fast path - for experienced Eclipse developers">
+<a name="fastpath"/>
+	<p>
+		If you know your way around Eclipse JDT, then following these steps will
+		have you hacking Harmony Java code in no time at all!
+	</p>
+
+<subsection name="Configuring Eclipse">
+	<p>
+		Ensure that you have <a href="#prerequisites">the development pre-requisites</a>
+		in place, then:
+		<ol>
+			<li>Launch Eclipse with the VM argument &quot;<code>-Dpde.jreProfile=none</code>&quot;
+				(i.e. <code>eclipse -vmargs -Dpde.jreProfile=none</code>).</li>
+			<li>Configure the following settings in <code>Window &gt; Preferences...</code>
+				<ul>
+					<li>Change the Java compiler settings
+						<ol>
+							<li>In the <code>Java &gt; Compiler</code> preferences ensure the
+								&quot;<code>Compiler compliance level</code>&quot; is set to
+								<code>1.4</code>.</li>
+							<li>In the <code>Java &gt; Compiler &gt; Building</code> preferences,
+								open the &quot;<code>Build Path Problems</code>&quot; section
+								and change &quot;<code>Circular Dependencies</code>&quot; from
+								<code>Error</code> to <code>Warning</code>.</li>
+						</ol></li>
+					<li>Change the PDE settings
+						<ol>
+							<li>In the <code>Plug-in Development &gt; Compilers</code> preferences
+								change &quot;<code>Unresolved Dependencies</code>&quot; from
+								<code>Error</code> to <code>Warning</code>.</li>
+							<li>In the <code>Plug-in Development &gt; Target Platform</code>
+								preferences, change the &quot;Location:&quot; box to be the
+								<code>jre/lib/boot</code> directory of the classlib snapshot.</li>
+						</ol></li>
+				</ul></li>
+			<li>Create a SVN repository location to the Harmony classlib, using URL
+				<code>https://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib</code></li>
+		</ol>
+	</p>
+</subsection>
+
+<subsection name="Develop and test code">
+	<p>
+		The Apache Harmony class library is structured to allow developers to work on individual
+		<em>modules</em> in the class library without having to load and compile the entire
+		project source tree.
+	</p>
+	<p>
+		This is best illustrated by a worked example.  In this example, assume you want to make
+		a change to the <code>NIO</code> module.  This is how you would proceed:
+		<ol>
+			<li>Go to the SVN repository view, open the Harmony URL and browse to
+				&quot;<code>trunk &gt; modules</code>&quot;.  Select
+				&quot;<code>nio</code>&quot; and from the context menu select
+				<code>Checkout...</code>, and on the checkout dialog just
+				click &quot;<code>Finish</code>&quot;</li>
+			<li>In the resulting project in your workspace the implementation code
+				is in the source folder <code>src/main/java</code> and the unit tests
+				are in the source folder <code>src/test/java</code>.</li>
+			<li>Hack away!  Developers are encouraged to produce JUnit tests for new
+				implementation code.</li>
+			<li>To test the code you need to set-up a JUnit Run Configuration for the
+				unit test.  You can either run a single test case, or run the
+				<code>AllTests</code> suite for all tests in a package or module.
+				For example, to run the test suite
+				<code>org.apache.harmony.tests.nio.AllTests</code> set up a
+				run configuration with the following characteristics:
+				<ul>
+					<li><em>bootclasspath</em> : the folder nio/bin/main, followed by
+						the Harmony JRE library.</li>
+					<li><em>classpath</em> : the folder nio/bin/test, followed by the
+						JUNIT JAR file.</li>
+					<br/>
+					<img src="../../images/dev_eclipse_runconf.jpg" alt="Java run configuration"/>
+					<li><em>VM</em> : the Harmony JRE as the launching VM.</li>
+				</ul>
+			</li>
+			<li>If everything looks good, go ahead and
+				<a href="../../get-involved.html#create_patch">contribute a patch</a>.</li>
+		</ol>
+	</p>
+</subsection>
+</section>
+
+<section name="Step-by-step guide to Eclipse-based development">
+<a name="step_guide"/>
+	<p>
+		We have produced a brief webcast for those who want to see a step-by-step guide
+		to configuring Eclipse, and developing a patch to the classlibrary code.  The webcast
+		starts assuming you have already installed the pre-requisities for Eclipse-based
+		development, and launched Eclipse with the following commandline:
+		<pre>eclipse -vmargs -Dpde.jreProfile=none</pre>
+		We <a href="dev_eclipse_movie.html">pick up the story here...</a> (<em>Warning 8Mb flash download!</em>)
+	</p>
+</section>
+
+</body>
 </document>

Propchange: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse_movie.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse_movie.html?view=diff&rev=451271&r1=451270&r2=451271
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse_movie.html (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse_movie.html Fri Sep 29 05:55:25 2006
@@ -1,71 +1,71 @@
-<!--
-
-    Copyright 2006 The Apache Software Foundation
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
--->
-
-<html>
-<body>
-	<!-- START lines taken from a generated page to ge the header logos -->
-            <table border="0" width="100%" cellspacing="0">
-                <!-- TOP IMAGE -->
-                <tr>
-                    <td align='LEFT'>
-                    <table><tr><td>
-                    <td align="left">
-<a href="http://incubator.apache.org/harmony/"><img  src="../../images/harmony-logo.png" alt="Apache Harmony" border="0"/></a>
-</td>
-</td>
-                    </td></tr></table>
-                    </td>
-                    <td align='RIGHT'>
-                    <a href="http://incubator.apache.org/harmony/">
-                    <img src="http://incubator.apache.org/harmony/images/apache-incubator-logo.png"
-                    	alt="Apache Harmony" border="0"/></a>                    
-                    </td>
-                </tr>
-            </table>
-	<!-- END lines taken from a generated page to ge the header logos -->
-	            
-<hr/>
-<p/>
-<center>
-	<h2>Eclipse-based development : The Movie</h2>
-
-	<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"
-		width="994"
-		height="755"
-		codebase="http://active.macromedia.com/flash5/cabs/swflash.cab#version=5,0,0,0">
-		
-		<param name=movie value="../../images/eclipse_movie.swf">
-		<param name=play value=true>
-		<param name=loop value=false>
-		<param name=quality value=low>
-		
-		<embed src="../../images/eclipse_movie.swf"
-			width=994
-			height=755
-			quality=low
-			loop=false
-			type="application/x-shockwave-flash"
-			pluginspage="http://www.macromedia.com/shockwave/download/index.cgi?P1_Prod_Version=ShockwaveFlash">
-		</embed>
-	</object>
-</center>
-<hr/>
-<p>
-	After watching the movie return to <a href="dev_eclipse.html">the Eclipse-based development page</a>.
-</p>
-</body>
-</html>
+<!--
+
+    Copyright 2006 The Apache Software Foundation
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<html>
+<body>
+	<!-- START lines taken from a generated page to ge the header logos -->
+            <table border="0" width="100%" cellspacing="0">
+                <!-- TOP IMAGE -->
+                <tr>
+                    <td align='LEFT'>
+                    <table><tr><td>
+                    <td align="left">
+<a href="http://incubator.apache.org/harmony/"><img  src="../../images/harmony-logo.png" alt="Apache Harmony" border="0"/></a>
+</td>
+</td>
+                    </td></tr></table>
+                    </td>
+                    <td align='RIGHT'>
+                    <a href="http://incubator.apache.org/harmony/">
+                    <img src="http://incubator.apache.org/harmony/images/apache-incubator-logo.png"
+                    	alt="Apache Harmony" border="0"/></a>                    
+                    </td>
+                </tr>
+            </table>
+	<!-- END lines taken from a generated page to ge the header logos -->
+	            
+<hr/>
+<p/>
+<center>
+	<h2>Eclipse-based development : The Movie</h2>
+
+	<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"
+		width="994"
+		height="755"
+		codebase="http://active.macromedia.com/flash5/cabs/swflash.cab#version=5,0,0,0">
+		
+		<param name=movie value="../../images/eclipse_movie.swf">
+		<param name=play value=true>
+		<param name=loop value=false>
+		<param name=quality value=low>
+		
+		<embed src="../../images/eclipse_movie.swf"
+			width=994
+			height=755
+			quality=low
+			loop=false
+			type="application/x-shockwave-flash"
+			pluginspage="http://www.macromedia.com/shockwave/download/index.cgi?P1_Prod_Version=ShockwaveFlash">
+		</embed>
+	</object>
+</center>
+<hr/>
+<p>
+	After watching the movie return to <a href="dev_eclipse.html">the Eclipse-based development page</a>.
+</p>
+</body>
+</html>

Propchange: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse_movie.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml?view=diff&rev=451271&r1=451270&r2=451271
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml Fri Sep 29 05:55:25 2006
@@ -1,146 +1,146 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-
-<!--
-
-    Copyright 2006 The Apache Software Foundation
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
--->
-
-<document>
-
-<properties>
-	<title>Apache Harmony</title>
-	<author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
-</properties>
-
-<body>
-
-<section name="Apache Harmony Class Library">
-	<p>
-		The following documentation links are specific to the class library effort underway at Apache Harmony.
-	</p>
-	
-<subsection name="Developing and Building the code">
-	<ul>
-		<li>
-            <a href="build_classlib.html">Building the Classlibrary Code</a>
-			<br />
-                Describes how to download and build the class library code from source.
-
-        </li>
-		<li>
-            <a href="dev_eclipse.html">Development with the Eclipse IDE</a>
-			<br />
-                Describes how to set up Eclipse to develop the class library code.
-
-        </li>
-		<li>
-            <a href="hdk.html">Harmony Development Kit</a>
-            <br />
-                Development bundle providing all jars, native binaries, dependencies and
-                header files to aid in Harmony development.
-
-        </li>
-	</ul>
-</subsection>
-
-<subsection name="Project Conventions">
-	<ul>
-		<li><a href="pkgnaming.html">Java package naming guidelines</a>
-      <br />
-      Guidelines for Harmony package naming convention.
-      
-    </li>
-
-    <li>
-      <a href="testing.html">Testing conventions in the Apache Harmony Classlib</a>
-      <br />
-      Placement and package naming conventions for different
-      types of Harmony class library tests.
-
-    </li>
-
-    <li>
-      <a href="compat.html">Compatibility guidelines</a>
-      <br />
-      Guidelines for ensuring that the Harmony class library is compatible
-      with other Java implementations.
-      
-			</li>
-
-		<li><a href="ser_testing.html">Framework for testing serialization</a>
-      <br />
-      Approach for testing serialization compatibility with other
-      certified implementations, Harmony backward compatibility, placement and
-      naming conventions for resource files.
-      
-			</li>
-
-		<li><a href="agreements.html">Harmony-dev agreements</a>
-      <br />
-      Summary of agreements and recommendations worked out on harmony-dev mailing list.
-      
-			</li>
-	</ul>
-</subsection>
-
-<subsection name="Architecture and guides">
-	<ul>
-		<li>
-      
-        <a href="asn1_framework.html">Harmony ASN1 Framework</a>
-        <br />
-        Introduction to the ASN.1 (Abstract Syntax Notation) framework with
-        an overview of ASN.1 types and encoding rules focusing on the characteristics
-        of the current implementation.
-
-      </li>
-      <li>
-        <a href="regexp.html">Harmony Regular Expression Framework</a>
-        <br />
-        Overview of the java.util.regex package and implementation architecture
-        focusing on the performance improvement aspects.
-
-      </li>
-      <li>
-        <a href="dns_support.html">Harmony DNS Service Provider</a>
-        <br />
-        Implementation description of the DNS service provider for the Java* Naming Directory Interface (JNDI)
-        including a package overview, a design description and a guide to using the provider.
-
-      </li>
-      <li>
-        <a href="awt.html">Harmony Abstract Window Toolkit Framework</a>
-        <br />
-        Description of the AWT (Abstract Window Toolkit) framework covering
-        major design features and internal implementation specifics, such as
-        the event handling mechanism, the focus dispatching flow, appearance handling
-        with custom visual themes and multi-threading support
-
-      </li>
-      <li>
-        <a href="java2d.html">Harmony Java 2D implementation</a>
-        <br />
-        Introduction to the Java two-dimensional (2D) graphics and image processing
-        technology implementation focusing on the internal specifics of implementation
-
-      </li>
-
-	</ul>
-</subsection>
-
-</section>
-
-</body>
-</document>
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+
+    Copyright 2006 The Apache Software Foundation
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+
+<properties>
+	<title>Apache Harmony</title>
+	<author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+</properties>
+
+<body>
+
+<section name="Apache Harmony Class Library">
+	<p>
+		The following documentation links are specific to the class library effort underway at Apache Harmony.
+	</p>
+	
+<subsection name="Developing and Building the code">
+	<ul>
+		<li>
+            <a href="build_classlib.html">Building the Classlibrary Code</a>
+			<br />
+                Describes how to download and build the class library code from source.
+
+        </li>
+		<li>
+            <a href="dev_eclipse.html">Development with the Eclipse IDE</a>
+			<br />
+                Describes how to set up Eclipse to develop the class library code.
+
+        </li>
+		<li>
+            <a href="hdk.html">Harmony Development Kit</a>
+            <br />
+                Development bundle providing all jars, native binaries, dependencies and
+                header files to aid in Harmony development.
+
+        </li>
+	</ul>
+</subsection>
+
+<subsection name="Project Conventions">
+	<ul>
+		<li><a href="pkgnaming.html">Java package naming guidelines</a>
+      <br />
+      Guidelines for Harmony package naming convention.
+      
+    </li>
+
+    <li>
+      <a href="testing.html">Testing conventions in the Apache Harmony Classlib</a>
+      <br />
+      Placement and package naming conventions for different
+      types of Harmony class library tests.
+
+    </li>
+
+    <li>
+      <a href="compat.html">Compatibility guidelines</a>
+      <br />
+      Guidelines for ensuring that the Harmony class library is compatible
+      with other Java implementations.
+      
+			</li>
+
+		<li><a href="ser_testing.html">Framework for testing serialization</a>
+      <br />
+      Approach for testing serialization compatibility with other
+      certified implementations, Harmony backward compatibility, placement and
+      naming conventions for resource files.
+      
+			</li>
+
+		<li><a href="agreements.html">Harmony-dev agreements</a>
+      <br />
+      Summary of agreements and recommendations worked out on harmony-dev mailing list.
+      
+			</li>
+	</ul>
+</subsection>
+
+<subsection name="Architecture and guides">
+	<ul>
+		<li>
+      
+        <a href="asn1_framework.html">Harmony ASN1 Framework</a>
+        <br />
+        Introduction to the ASN.1 (Abstract Syntax Notation) framework with
+        an overview of ASN.1 types and encoding rules focusing on the characteristics
+        of the current implementation.
+
+      </li>
+      <li>
+        <a href="regexp.html">Harmony Regular Expression Framework</a>
+        <br />
+        Overview of the java.util.regex package and implementation architecture
+        focusing on the performance improvement aspects.
+
+      </li>
+      <li>
+        <a href="dns_support.html">Harmony DNS Service Provider</a>
+        <br />
+        Implementation description of the DNS service provider for the Java* Naming Directory Interface (JNDI)
+        including a package overview, a design description and a guide to using the provider.
+
+      </li>
+      <li>
+        <a href="awt.html">Harmony Abstract Window Toolkit Framework</a>
+        <br />
+        Description of the AWT (Abstract Window Toolkit) framework covering
+        major design features and internal implementation specifics, such as
+        the event handling mechanism, the focus dispatching flow, appearance handling
+        with custom visual themes and multi-threading support
+
+      </li>
+      <li>
+        <a href="java2d.html">Harmony Java 2D implementation</a>
+        <br />
+        Introduction to the Java two-dimensional (2D) graphics and image processing
+        technology implementation focusing on the internal specifics of implementation
+
+      </li>
+
+	</ul>
+</subsection>
+
+</section>
+
+</body>
+</document>

Propchange: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml?view=diff&rev=451271&r1=451270&r2=451271
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml Fri Sep 29 05:55:25 2006
@@ -1,110 +1,110 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!--
-
-    Copyright 2006 The Apache Software Foundation
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
--->
-
-<document>
-
- <properties>
-  <title>Package naming conventions in the Apache Harmony Classlib</title>
-  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
- </properties>
-
-<body>
-
-<section name="Package naming conventions used in the Apache Harmony Class Library">
-	<p>
-		<small><em>This section is inspired by, and derived from,
-		<a href="http://dev.eclipse.org/naming.html">the Eclipse package naming convention</a>
-		documentation.</em></small>
-	</p>
-	<p>
-		The Harmony class library code is organized into Java packages comprising the
-		public API (packages such as <code>java.lang</code>, <code>org.omg.CORBA</code>
-		and so on) and internal implementation packages that all begin
-		<code>org.apache.harmony</code>.
-	</p>
-	<p>
-		The public APIs are defined by the JSE specification, and as such as managed beyond
-		the direct control of the Apache Harmony project.  The other packages are managed
-		by the project development team, and as such the project attributes the following
-		meaning to package names.
-	</p>
-
-<subsection name="All packages belong to a specific module">
-	<p>
-		Each Java package is owned by a specific module of the Harmony class library.
-		The module name immediately follows the <code>org.apache.harmony</code> prefix.
-			<blockquote>
-				<code>org.apache.harmony.<b>&lt;module&gt;</b></code>
-			</blockquote>
-		for example
-			<blockquote>
-				<code>org.apache.harmony.luni</code><br/>
-				<code>org.apache.harmony.security</code>
-			</blockquote>
-	</p>
-</subsection>
-
-<subsection name="Package names within a module">
-	<p>
-		Modules are free to use whatever package names they choose with the
-		prefix <code>org.apache.harmony.<b>&lt;modulename&gt;</b></code>
-	</p>
-	<p>
-		The following package name segements are <ul>reserved</ul> to indicate the meanings
-		defined below:
-		<ul>
-			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>internal</b></code>
-			<p>
-				Packages with this prefix are implementation packages for use within
-				the given module.  Types and fields that are visible within these
-				packages <em>MUST NOT</em> be used outside the module itself.
-				Some runtime environments may enforce this reduced visibility scope.
-			</p></li>
-			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>tests</b></code>
-			<p>
-				Packages with this prefix contain test code that is not part of the
-				module API or implementation.  Some builds may not include these
-				packages. See <a href="testing.html">Testing conventions in the Apache Harmony Classlib</a>
-                                for details.
-			</p></li>
-			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>examples</b></code>
-			<p>
-				Packages with this prefix contain example code that is not part of the
-				module API or implementation.  Some builds may not include these
-				packages.
-			</p></li>
-			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>&lt;anything_else&gt;</b></code>
-			<p>
-				All other packages within a module contain internal APIs that may
-				be referenced from any module.
-			</p></li>
-		</ul>
-	</p>
-	<p>
-		In practice, this means that module developers are free to change the code within an
-		<code>internal</code> package without expecting any consequences beyond the module
-		itself.  However, module developers who modify code that is not in an
-		<code>internal</code> package must do so in a manner that ensures
-		<a href="http://java.sun.com/docs/books/jls/second_edition/html/binaryComp.doc.html">
-		Java binary compatibility</a>
-	</p>
-</subsection>
-</section>
-</body>
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+    Copyright 2006 The Apache Software Foundation
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+
+ <properties>
+  <title>Package naming conventions in the Apache Harmony Classlib</title>
+  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+<body>
+
+<section name="Package naming conventions used in the Apache Harmony Class Library">
+	<p>
+		<small><em>This section is inspired by, and derived from,
+		<a href="http://dev.eclipse.org/naming.html">the Eclipse package naming convention</a>
+		documentation.</em></small>
+	</p>
+	<p>
+		The Harmony class library code is organized into Java packages comprising the
+		public API (packages such as <code>java.lang</code>, <code>org.omg.CORBA</code>
+		and so on) and internal implementation packages that all begin
+		<code>org.apache.harmony</code>.
+	</p>
+	<p>
+		The public APIs are defined by the JSE specification, and as such as managed beyond
+		the direct control of the Apache Harmony project.  The other packages are managed
+		by the project development team, and as such the project attributes the following
+		meaning to package names.
+	</p>
+
+<subsection name="All packages belong to a specific module">
+	<p>
+		Each Java package is owned by a specific module of the Harmony class library.
+		The module name immediately follows the <code>org.apache.harmony</code> prefix.
+			<blockquote>
+				<code>org.apache.harmony.<b>&lt;module&gt;</b></code>
+			</blockquote>
+		for example
+			<blockquote>
+				<code>org.apache.harmony.luni</code><br/>
+				<code>org.apache.harmony.security</code>
+			</blockquote>
+	</p>
+</subsection>
+
+<subsection name="Package names within a module">
+	<p>
+		Modules are free to use whatever package names they choose with the
+		prefix <code>org.apache.harmony.<b>&lt;modulename&gt;</b></code>
+	</p>
+	<p>
+		The following package name segements are <ul>reserved</ul> to indicate the meanings
+		defined below:
+		<ul>
+			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>internal</b></code>
+			<p>
+				Packages with this prefix are implementation packages for use within
+				the given module.  Types and fields that are visible within these
+				packages <em>MUST NOT</em> be used outside the module itself.
+				Some runtime environments may enforce this reduced visibility scope.
+			</p></li>
+			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>tests</b></code>
+			<p>
+				Packages with this prefix contain test code that is not part of the
+				module API or implementation.  Some builds may not include these
+				packages. See <a href="testing.html">Testing conventions in the Apache Harmony Classlib</a>
+                                for details.
+			</p></li>
+			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>examples</b></code>
+			<p>
+				Packages with this prefix contain example code that is not part of the
+				module API or implementation.  Some builds may not include these
+				packages.
+			</p></li>
+			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>&lt;anything_else&gt;</b></code>
+			<p>
+				All other packages within a module contain internal APIs that may
+				be referenced from any module.
+			</p></li>
+		</ul>
+	</p>
+	<p>
+		In practice, this means that module developers are free to change the code within an
+		<code>internal</code> package without expecting any consequences beyond the module
+		itself.  However, module developers who modify code that is not in an
+		<code>internal</code> package must do so in a manner that ensures
+		<a href="http://java.sun.com/docs/books/jls/second_edition/html/binaryComp.doc.html">
+		Java binary compatibility</a>
+	</p>
+</subsection>
+</section>
+</body>
 </document>

Propchange: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/status.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/status.xml?view=diff&rev=451271&r1=451270&r2=451271
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/status.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/status.xml Fri Sep 29 05:55:25 2006
@@ -1,91 +1,91 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-
-<!--
-
-    Copyright 2006 The Apache Software Foundation
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
--->
-
-<document>
-
- <properties>
-  <title>Apache Harmony</title>
-  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
- </properties>
-
- <body>
-
-<section name="Class Library Component Status">
-
-	<p>
-		The following table shows the basic status of each module in Harmony's
-		class library effort.  Each module represents
-		<a href="http://wiki.apache.org/harmony/componentization">a set of Java
-		API packages</a>.
-	</p>
-	
-	<p>
-	    Stuart Ballard of the Kaffe project is generously creating automated coverage comparisons
-	    of 
-	    <a href="http://www.kaffe.org/~stuart/japi/htmlout/h-jdk14-harmony.html">JDK 1.4</a>
-	    and 
-	    <a href="http://www.kaffe.org/~stuart/japi/htmlout/h-jdk15-harmony.html">JDK 1.5</a>.
-	    against the
-	    <a href="http://cvs.apache.org/dist/incubator/harmony/snapshots/">Harmony class library snapshots.</a>
-	</p>
-	
-<table>
-	<tr><th>Module Name</th>		<th>Status</th></tr>
-	<tr><td>ACCESSIBILITY</td>		<td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/accessibility/">accessibility</a></td></tr>
-	<tr><td>ANNOTATION</td>			<td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/annotation/">annotation</a></td></tr>
-	<tr><td>APPLET</td>             <td>Missing</td></tr>
-	<tr><td>ARCHIVE</td>            <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/archive/">archive</a></td></tr>
-	<tr><td>AUTH</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/auth/">auth</a></td></tr>
-	<tr><td>AWT</td>            <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/awt/">awt</a></td></tr>
-	<tr><td>BEANS</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/beans/">beans</a></td></tr>
-	<tr><td>CONCURRENT</td>			<td>Missing</td></tr>
-	<tr><td>CRYPTO</td>             <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/crypto/">crypto</a></td></tr>
-	<tr><td>IMAGEIO</td>			<td>Missing</td></tr>
-	<tr><td>INSTRUMENT</td>			<td>Missing</td></tr>
-	<tr><td>JMX</td>                <td>Missing</td></tr>
-	<tr><td>JNDI</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/jndi/">jndi</a></td></tr>
-	<tr><td>LANG-MANAGEMENT</td>    <td>Missing</td></tr>
-	<tr><td>LOGGING</td>            <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/logging/">logging</a></td></tr>
-	<tr><td>LUNI</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/luni/">luni</a></td></tr>
-	<tr><td>MATH</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/math/">math</a></td></tr>
-	<tr><td>NIO-CHANNELS</td>		<td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/nio/">nio</a></td></tr>
-	<tr><td>NIO-CHARSET</td>		<td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/nio_char/">nio_char</a></td></tr>
-	<tr><td>ORB</td>                <td>Missing</td></tr>
-	<tr><td>PREFS</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/prefs/">prefs</a></td></tr>
-	<tr><td>PRINT</td>              <td>Missing</td></tr>
-	<tr><td>REGEX</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/regex/">regex</a></td></tr>
-	<tr><td>RMI</td>                <td>Contributed in <a href="http://issues.apache.org/jira/browse/HARMONY-221">HARMONY-221</a> and <a href="http://issues.apache.org/jira/browse/HARMONY-337">HARMONY-337</a></td></tr>
-	<tr><td>SECURITY</td>           <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/security/">security</a></td></tr>
-	<tr><td>SOUND</td>              <td>Missing</td></tr>
-	<tr><td>SQL</td>                <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/sql/">sql</a></td></tr>
-	<tr><td>SWING</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/swing/">swing</a></td></tr>
-	<tr><td>TEXT</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/text/">text</a></td></tr>
-	<tr><td>X-NET</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/x-net/">x-net</a></td></tr>
-	<tr><td>XML</td>                <td>Intend to use <a href="http://xerces.apache.org/xerces2-j/">Apache Xerces</a></td></tr>
-</table>
-
- </section>
-
- </body>
- </document>
-
-
-
-
-
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+
+    Copyright 2006 The Apache Software Foundation
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+
+ <properties>
+  <title>Apache Harmony</title>
+  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+ <body>
+
+<section name="Class Library Component Status">
+
+	<p>
+		The following table shows the basic status of each module in Harmony's
+		class library effort.  Each module represents
+		<a href="http://wiki.apache.org/harmony/componentization">a set of Java
+		API packages</a>.
+	</p>
+	
+	<p>
+	    Stuart Ballard of the Kaffe project is generously creating automated coverage comparisons
+	    of 
+	    <a href="http://www.kaffe.org/~stuart/japi/htmlout/h-jdk14-harmony.html">JDK 1.4</a>
+	    and 
+	    <a href="http://www.kaffe.org/~stuart/japi/htmlout/h-jdk15-harmony.html">JDK 1.5</a>.
+	    against the
+	    <a href="http://cvs.apache.org/dist/incubator/harmony/snapshots/">Harmony class library snapshots.</a>
+	</p>
+	
+<table>
+	<tr><th>Module Name</th>		<th>Status</th></tr>
+	<tr><td>ACCESSIBILITY</td>		<td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/accessibility/">accessibility</a></td></tr>
+	<tr><td>ANNOTATION</td>			<td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/annotation/">annotation</a></td></tr>
+	<tr><td>APPLET</td>             <td>Missing</td></tr>
+	<tr><td>ARCHIVE</td>            <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/archive/">archive</a></td></tr>
+	<tr><td>AUTH</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/auth/">auth</a></td></tr>
+	<tr><td>AWT</td>            <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/awt/">awt</a></td></tr>
+	<tr><td>BEANS</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/beans/">beans</a></td></tr>
+	<tr><td>CONCURRENT</td>			<td>Missing</td></tr>
+	<tr><td>CRYPTO</td>             <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/crypto/">crypto</a></td></tr>
+	<tr><td>IMAGEIO</td>			<td>Missing</td></tr>
+	<tr><td>INSTRUMENT</td>			<td>Missing</td></tr>
+	<tr><td>JMX</td>                <td>Missing</td></tr>
+	<tr><td>JNDI</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/jndi/">jndi</a></td></tr>
+	<tr><td>LANG-MANAGEMENT</td>    <td>Missing</td></tr>
+	<tr><td>LOGGING</td>            <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/logging/">logging</a></td></tr>
+	<tr><td>LUNI</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/luni/">luni</a></td></tr>
+	<tr><td>MATH</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/math/">math</a></td></tr>
+	<tr><td>NIO-CHANNELS</td>		<td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/nio/">nio</a></td></tr>
+	<tr><td>NIO-CHARSET</td>		<td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/nio_char/">nio_char</a></td></tr>
+	<tr><td>ORB</td>                <td>Missing</td></tr>
+	<tr><td>PREFS</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/prefs/">prefs</a></td></tr>
+	<tr><td>PRINT</td>              <td>Missing</td></tr>
+	<tr><td>REGEX</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/regex/">regex</a></td></tr>
+	<tr><td>RMI</td>                <td>Contributed in <a href="http://issues.apache.org/jira/browse/HARMONY-221">HARMONY-221</a> and <a href="http://issues.apache.org/jira/browse/HARMONY-337">HARMONY-337</a></td></tr>
+	<tr><td>SECURITY</td>           <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/security/">security</a></td></tr>
+	<tr><td>SOUND</td>              <td>Missing</td></tr>
+	<tr><td>SQL</td>                <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/sql/">sql</a></td></tr>
+	<tr><td>SWING</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/swing/">swing</a></td></tr>
+	<tr><td>TEXT</td>               <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/text/">text</a></td></tr>
+	<tr><td>X-NET</td>              <td>Present as module <a href="http://svn.apache.org/viewcvs.cgi/incubator/harmony/enhanced/classlib/trunk/modules/x-net/">x-net</a></td></tr>
+	<tr><td>XML</td>                <td>Intend to use <a href="http://xerces.apache.org/xerces2-j/">Apache Xerces</a></td></tr>
+</table>
+
+ </section>
+
+ </body>
+ </document>
+
+
+
+
+

Propchange: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/status.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/testing.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/testing.xml?view=diff&rev=451271&r1=451270&r2=451271
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/testing.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/testing.xml Fri Sep 29 05:55:25 2006
@@ -1,133 +1,133 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!--
-
-    Copyright 2006 The Apache Software Foundation
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
-    You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-    Unless required by applicable law or agreed to in writing, software
-    distributed under the License is distributed on an "AS IS" BASIS,
-    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    See the License for the specific language governing permissions and
-    limitations under the License.
--->
-
-<document>
-
- <properties>
-  <title>Testing conventions in the Apache Harmony Classlib</title>
-  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
- </properties>
-
-<body>
-
-<section name="Testing conventions used in the Apache Harmony Class Library">
-	<p>
-		This document describes PROPOSED placement and package naming conventions for
-                different types of Harmony class library tests.
-	</p>
-	<p>
-		The Harmony class library code is organized into modules that might have their own
-                specifics. This document provides general guidlines and recomendations that might be
-                adapted/modified to reflect module specifics.
-	</p>
-	<p>
-		See also: <a href="ser_testing.html">Framework for testing serialization</a>
-	</p>
-
-<subsection name="Location of the tests in the directory tree">
-	<p>
-		Each Java class belongs to a specific module of the Harmony class library. Tests against
-                classes belonging to a module belong to the same module. Tests, their resources, and support
-                classes are located under
-			<blockquote>
-				<code>&lt;modulename&gt;/src/test</code>
-			</blockquote>
-		Tests that are specific for Harmony, testing Harmony implementation details, and may fail
-                on RI or other compliant implementations are separated from the imlpementation-independent
-                tests that must pass on RI and all conformant implementations. 
-			<blockquote>
-				<code>&lt;modulename&gt;/src/test/<b>impl</b></code> - Harmony specific tests<br/>
-				<code>&lt;modulename&gt;/src/test/<b>api</b></code> - Implementation-independent tests
-			</blockquote>
-                Special-purpose tests like stress tests or tests that require special configuration are 
-                separated from general-purpose tests.
-			<blockquote>
-				<code>&lt;modulename&gt;/src/test/<b>stress</b></code>
-			</blockquote>
-
-                Tests are not separated by functionality under test, e.g. tests against <code>clone()</code>
-                methods are <b>not</b> separated from tests against <code>equals()</code> methods.
-
-                Classpath tests are separated from bootclasspath tests on a directory level:
-			<blockquote>
-				<code>&lt;modulename&gt;/src/test/api/<b>java</b></code> - Classpath tests<br/>
-				<code>&lt;modulename&gt;/src/test/api/<b>java.injected</b></code> - Bootclasspath tests<br/>
-			</blockquote>
-                More details below.<br/><br/>
-
-
-                Some modules might have platform specific tests that are in the case separated on a directory 
-                level:
-			<blockquote>
-				<code>&lt;modulename&gt;/src/test/api/<b>common</b></code><br/>
-				<code>&lt;modulename&gt;/src/test/api/<b>windows</b></code><br/>
-				<code>&lt;modulename&gt;/src/test/api/<b>linux</b></code>
-			</blockquote>
-	</p>
-</subsection>
-
-<subsection name="Package and class names for different types of the tests">
-	<p>
-		If the test is designed to be run from bootclasspath then its package is the same
-                as the package of the class under test
-	</p>
-	<p>
-		If the test is designed to be run from classpath then:<br/>
-                If the package under test belongs to a public package (i.e. that is a part of the API specification)
-                then the test's package is 
-			<blockquote>
-				<code>org.apache.harmony.&lt;modulename&gt;.tests.<b>&lt;package under test&gt;</b></code>
-			</blockquote>
-                Example: 
-			<blockquote>
-				<code>org.apache.harmony.luni.tests.<b>java.lang</b></code><br/>
-				<code>org.apache.harmony.crypto.tests.<b>javax.crypto</b></code><br/>
-				<code>org.apache.harmony.auth.tests.<b>org.ietf.jgss</b></code>
-			</blockquote>
-
-                If the package under test belongs to <code>org.apache.harmony</code> namespace so that class's package is
-			<blockquote>
-				<code>org.apache.harmony.&lt;modulename&gt;.<b>&lt;rest of the package name&gt;</b></code>
-			</blockquote>
-                then the test's package is 
-			<blockquote>
-				<code>org.apache.harmony.&lt;modulename&gt;.tests.<b>&lt;rest of the package name&gt;</b></code>
-			</blockquote>
-                Example: 
-			<blockquote>
-				<code>org.apache.harmony.luni.internal.net.www.protocol</code> - package under test<br/>
-				<code>org.apache.harmony.luni.tests.internal.net.www.protocol</code> - package for the test
-			</blockquote>
-
-
-	</p>
-	<p>
-                To avoid collision of test results for various type of tests, test type might be reflected in test name
-                for example, to separate impl test results from api test results impl test names end with 
-                <code>_ImplTest</code>
-			<blockquote>
-				<code>javax.crypto.<b>CipherTest</b></code> - Implementation independent bootclasspath test for <code>javax.crypto.Cipher</code><br/>
-				<code>javax.crypto.<b>Cipher_ImplTest</b></code> - Implementation specific bootclasspath test for <code>javax.crypto.Cipher</code><br/>
-			</blockquote>
-
-	</p>
-</subsection>
-</section>
-</body>
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+    Copyright 2006 The Apache Software Foundation
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+
+ <properties>
+  <title>Testing conventions in the Apache Harmony Classlib</title>
+  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+<body>
+
+<section name="Testing conventions used in the Apache Harmony Class Library">
+	<p>
+		This document describes PROPOSED placement and package naming conventions for
+                different types of Harmony class library tests.
+	</p>
+	<p>
+		The Harmony class library code is organized into modules that might have their own
+                specifics. This document provides general guidlines and recomendations that might be
+                adapted/modified to reflect module specifics.
+	</p>
+	<p>
+		See also: <a href="ser_testing.html">Framework for testing serialization</a>
+	</p>
+
+<subsection name="Location of the tests in the directory tree">
+	<p>
+		Each Java class belongs to a specific module of the Harmony class library. Tests against
+                classes belonging to a module belong to the same module. Tests, their resources, and support
+                classes are located under
+			<blockquote>
+				<code>&lt;modulename&gt;/src/test</code>
+			</blockquote>
+		Tests that are specific for Harmony, testing Harmony implementation details, and may fail
+                on RI or other compliant implementations are separated from the imlpementation-independent
+                tests that must pass on RI and all conformant implementations. 
+			<blockquote>
+				<code>&lt;modulename&gt;/src/test/<b>impl</b></code> - Harmony specific tests<br/>
+				<code>&lt;modulename&gt;/src/test/<b>api</b></code> - Implementation-independent tests
+			</blockquote>
+                Special-purpose tests like stress tests or tests that require special configuration are 
+                separated from general-purpose tests.
+			<blockquote>
+				<code>&lt;modulename&gt;/src/test/<b>stress</b></code>
+			</blockquote>
+
+                Tests are not separated by functionality under test, e.g. tests against <code>clone()</code>
+                methods are <b>not</b> separated from tests against <code>equals()</code> methods.
+
+                Classpath tests are separated from bootclasspath tests on a directory level:
+			<blockquote>
+				<code>&lt;modulename&gt;/src/test/api/<b>java</b></code> - Classpath tests<br/>
+				<code>&lt;modulename&gt;/src/test/api/<b>java.injected</b></code> - Bootclasspath tests<br/>
+			</blockquote>
+                More details below.<br/><br/>
+
+
+                Some modules might have platform specific tests that are in the case separated on a directory 
+                level:
+			<blockquote>
+				<code>&lt;modulename&gt;/src/test/api/<b>common</b></code><br/>
+				<code>&lt;modulename&gt;/src/test/api/<b>windows</b></code><br/>
+				<code>&lt;modulename&gt;/src/test/api/<b>linux</b></code>
+			</blockquote>
+	</p>
+</subsection>
+
+<subsection name="Package and class names for different types of the tests">
+	<p>
+		If the test is designed to be run from bootclasspath then its package is the same
+                as the package of the class under test
+	</p>
+	<p>
+		If the test is designed to be run from classpath then:<br/>
+                If the package under test belongs to a public package (i.e. that is a part of the API specification)
+                then the test's package is 
+			<blockquote>
+				<code>org.apache.harmony.&lt;modulename&gt;.tests.<b>&lt;package under test&gt;</b></code>
+			</blockquote>
+                Example: 
+			<blockquote>
+				<code>org.apache.harmony.luni.tests.<b>java.lang</b></code><br/>
+				<code>org.apache.harmony.crypto.tests.<b>javax.crypto</b></code><br/>
+				<code>org.apache.harmony.auth.tests.<b>org.ietf.jgss</b></code>
+			</blockquote>
+
+                If the package under test belongs to <code>org.apache.harmony</code> namespace so that class's package is
+			<blockquote>
+				<code>org.apache.harmony.&lt;modulename&gt;.<b>&lt;rest of the package name&gt;</b></code>
+			</blockquote>
+                then the test's package is 
+			<blockquote>
+				<code>org.apache.harmony.&lt;modulename&gt;.tests.<b>&lt;rest of the package name&gt;</b></code>
+			</blockquote>
+                Example: 
+			<blockquote>
+				<code>org.apache.harmony.luni.internal.net.www.protocol</code> - package under test<br/>
+				<code>org.apache.harmony.luni.tests.internal.net.www.protocol</code> - package for the test
+			</blockquote>
+
+
+	</p>
+	<p>
+                To avoid collision of test results for various type of tests, test type might be reflected in test name
+                for example, to separate impl test results from api test results impl test names end with 
+                <code>_ImplTest</code>
+			<blockquote>
+				<code>javax.crypto.<b>CipherTest</b></code> - Implementation independent bootclasspath test for <code>javax.crypto.Cipher</code><br/>
+				<code>javax.crypto.<b>Cipher_ImplTest</b></code> - Implementation specific bootclasspath test for <code>javax.crypto.Cipher</code><br/>
+			</blockquote>
+
+	</p>
+</subsection>
+</section>
+</body>
 </document>

Propchange: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/testing.xml
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message