harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From apetre...@apache.org
Subject svn commit: r470718 - in /incubator/harmony/standard/site: docs/documentation/ docs/subcomponents/buildtest/ docs/subcomponents/classlibrary/ xdocs/documentation/ xdocs/subcomponents/buildtest/ xdocs/subcomponents/classlibrary/
Date Fri, 03 Nov 2006 08:27:21 GMT
Author: apetrenko
Date: Fri Nov  3 00:27:20 2006
New Revision: 470718

URL: http://svn.apache.org/viewvc?view=rev&rev=470718
Log:
HARMONY-2062 "Improve certain Harmony pages" applied

Modified:
    incubator/harmony/standard/site/docs/documentation/build_website.html
    incubator/harmony/standard/site/docs/subcomponents/buildtest/index.html
    incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html
    incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html
    incubator/harmony/standard/site/docs/subcomponents/classlibrary/testing.html
    incubator/harmony/standard/site/xdocs/documentation/build_website.xml
    incubator/harmony/standard/site/xdocs/subcomponents/buildtest/index.xml
    incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml
    incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml
    incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/testing.xml

Modified: incubator/harmony/standard/site/docs/documentation/build_website.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/documentation/build_website.html?view=diff&rev=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/docs/documentation/build_website.html (original)
+++ incubator/harmony/standard/site/docs/documentation/build_website.html Fri Nov  3 00:27:20 2006
@@ -220,7 +220,7 @@
       <tr><td>
         
                                     <p>
-		The following tools are required to build the Harmony website
+		The following tools are required to build the Harmony website:
 		
 		<ul>
 		    <li>
@@ -234,23 +234,22 @@
 			</li>
 		</ul>
 	</p>
-                                                <p>
-		<ol>
+                                                <ol>
 			<li>
-			   Download the website source from Harmony subversion repository
+			   Download the website source from Harmony subversion repository:</li>
 			   <pre>$ svn checkout https://svn.apache.org/repos/asf/incubator/harmony/standard/site</pre>
-			</li>
+		
 			
 			<li>
-			   Change into the site directory and run the default ant script target
-			  <pre>$ cd site</pre>
-			  <pre>$ ant</pre>
-			</li>
+			   Change into the site directory:
+     <pre>$ cd site</pre> </li>
+      <li>Run the default ant script target:</li>
+			 <pre>$ ant</pre>
+			
 	    </ol>
-	</p>
                                                 <p>
-	  At this point, you have a complete generated website and documentation in the <i>site/docs</i>
-	   subdirectory.  Open the <i>index.html</i> page and start browsing.
+	  At this point, you have a complete generated website and documentation in the 
+    <code>site/docs</code> subdirectory. Open the <code>index.html</code> page and start browsing.
 	</p>
                             
       </td></tr>
@@ -264,12 +263,13 @@
       <tr><td>
         
                                     <p>
-    Making changes is straightforward.  All edits are made to the contents of the <i>xdocs/</i> 
-    subdirectory, and then rendered via the procedure above into the <i>docs/</i> directory.
-  </p>
+    Making changes is straightforward.  All edits are made to the contents of the <code>xdocs/</code> 
+    subdirectory, and then rendered via the procedure above into the <code>docs/</code> directory.
+  
+</p>
                                                 <p>
-    If you are a Harmony committer, you can simply checkin your changes.  If you are not 
-    a committer, any updates and additions to the site are very welcome.  Please
+    If you are a Harmony committer, you can simply checkin your changes. If you are not 
+    a committer, any updates and additions to the site are very welcome. Please
     see our <a href="../get-involved.html">Get Involved</a> page for instructions
     on how to contribute your changes.
   </p>
@@ -286,30 +286,28 @@
         
                                     <p>
     If you are a Harmony Committer, you can commit your changes into SVN and then
-    publish to the project website.  Once the changes are in SVN, simply :
+    publish to the project website. Once the changes are in SVN, do the following:
   </p>
-                                                <p>
-    <ol>
+                                                <ol>
       <li>
-        SSH to minotaur.apache.org
+        SSH to <code>minotaur.apache.org</code>. Your login name will of course be your own.</li>
         <pre>$ ssh geirm@minotaur.apache.org </pre>
-        Your login name will of course be your own.
-      </li>
+        
       <li>
-        Go to the project website directory.
+        Go to the project website directory:</li>
         <pre>$ cd /www/incubator.apache.org/harmony/</pre>
-      </li>
+      
       <li>
-        Update the local copy.  There are two ways.  A simple
+        Update the local copy in one of two ways:
         <pre>$ svn update</pre>
-        will update the local copy.  If you need to delete the HTML and 
-        re-checout use 
-        <pre>$ `cat UPDATE`</pre>
-        as the UPDATE file has the command used to do a fresh svn checkout.
-      </li>
+        If you need to delete the HTML and 
+        re-checkout, use: 
+        <pre>$ `cat UPDATE`</pre></li>
+        <p class="note">Note</p>
+        <p class="notetext">The <code>UPDATE</code> file has the command performing a fresh svn checkout.</p> 
+     
         
     </ol>
-  </p>
                             
       </td></tr>
        

Modified: incubator/harmony/standard/site/docs/subcomponents/buildtest/index.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/subcomponents/buildtest/index.html?view=diff&rev=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/buildtest/index.html (original)
+++ incubator/harmony/standard/site/docs/subcomponents/buildtest/index.html Fri Nov  3 00:27:20 2006
@@ -214,14 +214,14 @@
                                     <p>
     The
     <a href="http://svn.apache.org/viewvc/incubator/harmony/enhanced/buildtest/">
-    'build-test framework'</a> is a simple configuration of
-    <a href="http://cruisecontrol.sourceforge.net/">Cruise Control</a>,
-    a framework for continuous build process.  It also includes all the
+      <i>build-test framework</i></a> is a simple configuration of
+    <a href="http://cruisecontrol.sourceforge.net/"><code>CruiseControl</code></a>,
+    a framework for continuous build process. It also includes all the
     necessary support to simplify installation.
 </p>
                                                 <p>
-    Currently, the framework does these distinct tasks, in order :
-</p>
+    Currently, the framework does the following distinct tasks, in order,
+    and only when code changes in the repository:</p>
                                                 <ol>
         <li>Update the source for the class library from SVN</li>
         <li>Get any new dependencies needed for building the class library</li>
@@ -230,9 +230,6 @@
         <li>Get and build any new dependencies needed for DRLVM</li>
         <li>Build and test the DRLVM</li>
     </ol>
-                                                <p>
-        It does these tasks in-order, and only when code changes in the repository.
-    </p>
                            
       </td></tr>
     </table>
@@ -244,89 +241,102 @@
         </h1>
       </td></tr>
       <tr><td>
-                                    <strong>Pre-requisites</strong>
-                                                <p>
-    Basically, you need the tools needed to build the Apache Harmony
-    components, like Java, Ant, C/C++ compilers, etc.  Please see
-    the other parts of the project for information on the necessary
-    toolchains.  You need the following software installed :
+                                        
+      <tr><td>
+            <h2>
+          <a name="Prerequisites">Prerequisites</a>
+            </h2>
+      </td></tr>
+      <tr><td>
+        
+                                    <p>
+    Basically, you need the same tools, as for building the Apache Harmony
+    components, like Java, Ant, C/C++ compilers, etc. Install the following 
+    software:
     </p>
                                                 <ol>
         <li>Java JDK v5</li>
         <li><a href="http://ant.apache.org/">Apache Ant</a></li>
         <li><a href="http;//subversion.tigris.org/">Subversion Client</a></li>
     </ol>
-                                                <strong>Setup</strong>
-                                                <p>
-       Get the /harmony/enhanced/buildtest/ part of the Apache
-       Harmony project.  If you are reading this, you either have
-       it via a zip or tgz, or have checked it out from the project
-       Subversion repository.  In the event that you don't have it
-       you can get it via subversion :
-    </p>
-                                                <blockquote>
-         svn co https://svn.apache.org/repos/asf/incubator/harmony/enhanced/buildtest/trunk
-    </blockquote>
+                                                <p>Please see the other parts of the project for information on the necessary
+    toolchains.</p>
+                            
+      </td></tr>
+       
+                                                    
+      <tr><td>
+            <h2>
+          <a name="Setup">Setup</a>
+            </h2>
+      </td></tr>
+      <tr><td>
+        
+                                    <p>
+       Get the <code>/harmony/enhanced/buildtest/</code> part of the Apache
+       Harmony project via <code>zip</code> or <code>tgz</code> files. You also can 
+       check it out from the project Subversion repository:</p>
+                                                <pre>svn co https://svn.apache.org/repos/asf/incubator/harmony/enhanced/buildtest/trunk</pre>
                                                 <p>
-       With Java, Ant and SVN installed, change into the buildtest/trunk
-       directory and type
+       With Java, Ant and SVN installed, change into the <code>buildtest/trunk</code>
+       directory and type:
     </p>
-                                                <blockquote>
-          ant setup
-    </blockquote>
+                                                <pre>ant setup</pre>
                                                 <p>
-       This should fetch CruiseControl, set it up with the Apache Harmony
-       configuration, and checkout the software to be built and tested
+       This command fetches <code>CruiseControl</code>, sets it up with the Apache Harmony
+       configuration, and checks out the software for building and testing 
        from Apache Harmony.
     </p>
                                                 <p>
-       If you wish to have the tests run successfully, you need to do the
-       following manual steps for now :
+       To run the tests successfully, you need to do the
+       following manual steps for now:
     </p>
                                                 <ol>
       <li>
-         build the classlib to create the deploy/jdk tree in classlib, first
-         fetching the dependencies
-        <blockquote>
-           cd cc/projects/classlib/trunk
-           ant fetch-depends
-           ant
-        </blockquote>
+         Build the classlib to create the <code>deploy/jdk</code> tree in classlib, 
+         first fetching the dependencies:
+        <pre>cd cc/projects/classlib/trunk
+ant fetch-depends
+ant</pre>
       </li>
       <li>
-         get the appropriate IBM J9 VM for your platform (this will go
-         away when DRLVM is good enough
+         Get the appropriate IBM J9 VM for your platform (this will go
+         away when DRLVM is good enough):
 
-         <blockquote>
-           http://www-128.ibm.com/developerworks/java/jdk/harmony/index.html
-         </blockquote>
+         <pre>http://www-128.ibm.com/developerworks/java/jdk/harmony/index.html</pre>
        </li>
 
         <li>
-         unpack the above-fetched J9 distribution into the jdk directory (as
-         the distro assumes it's dropped into the jdk directory...)
+         Unpack the above-fetched J9 distribution into the <code>jdk</code> directory (as
+         the distro assumes it is dropped into the<code>jdk</code> directory):
 
-        <blockquote>
-           cd cc/projects/classlib/trunk/deploy/jdk/ <br />
-           tar zxf Harmony-vme-linux.IA32-v4.tar.gz
-        </blockquote>
+        <pre>cd cc/projects/classlib/trunk/deploy/jdk/
+tar zxf Harmony-vme-linux.IA32-v4.tar.gz</pre>
         </li>
 
     </ol>
-                                                <strong>Starting CruiseControl</strong>
-                                                <p>
-        To start the system, just type :
-    </p>
-                                                <blockquote>
-         ant
-     </blockquote>
-                                                <p>
-       in buildtest/trunk and that will launch CC with the full test set.
-       To check status, point your browser to
-    </p>
-                                                <blockquote>
-       http://localhost:8080/
-   </blockquote>
+                            
+      </td></tr>
+       
+                                                    
+      <tr><td>
+            <h2>
+          <a name="Starting CruiseControl">Starting CruiseControl</a>
+            </h2>
+      </td></tr>
+      <tr><td>
+        
+                                    <p>
+        To start the system, type the following command in 
+        <code>buildtest/trunk</code>: 
+    </p>
+                                                <pre>ant</pre>
+                                                <p>The given command launches <code>CruiseControl</code> with the full test set. 
+    To check status, point your browser to:</p>
+                                                <pre>http://localhost:8080/</pre>
+                            
+      </td></tr>
+       
                            
       </td></tr>
     </table>

Modified: incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html?view=diff&rev=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html (original)
+++ incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html Fri Nov  3 00:27:20 2006
@@ -36,7 +36,7 @@
             
             
             
-            <title>Apache Harmony - Package naming conventions in the Apache Harmony Classlib</title>
+            <title>Apache Harmony - Package Naming Conventions in the Apache Harmony Classlib</title>
 
                                 <link rel="Stylesheet" type="text/css" href="site.css"/>
         </head>
@@ -207,13 +207,13 @@
                                                                     <table  cellspacing="0" cellpadding="2" width="100%">
       <tr><td>
         <h1>
-          <a name="Package naming conventions used in the Apache Harmony Class Library">Package naming conventions used in the Apache Harmony Class Library</a>
+          <a name="Package Naming Conventions Used in the Apache Harmony Class Library">Package Naming Conventions Used in the Apache Harmony Class Library</a>
         </h1>
       </td></tr>
       <tr><td>
                                     <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>
+		<a href="http://wiki.eclipse.org/index.php/Naming_Conventions">the Eclipse package naming convention</a>
 		documentation.</em></small>
 	</p>
                                                 <p>
@@ -224,29 +224,29 @@
 	</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
+		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>
                                                     
       <tr><td>
             <h2>
-          <a name="All packages belong to a specific module">All packages belong to a specific module</a>
+          <a name="All Packages Belong to a Specific Module">All Packages Belong to a Specific Module</a>
             </h2>
       </td></tr>
       <tr><td>
         
                                     <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>
+		The module name immediately follows the <code>org.apache.harmony</code> prefix.</p>
+                                                <pre>org.apache.harmony.<b>&lt;module&gt;</b></pre>
+                                                <p class="example">
+      Example
+    </p>
+                                                <p class="exampletext">
+			<pre>org.apache.harmony.luni
+org.apache.harmony.security</pre>
+			
 	</p>
                             
       </td></tr>
@@ -254,23 +254,23 @@
                                                     
       <tr><td>
             <h2>
-          <a name="Package names within a module">Package names within a module</a>
+          <a name="Package Names within a Module">Package Names within a Module</a>
             </h2>
       </td></tr>
       <tr><td>
         
                                     <p>
 		Modules are free to use whatever package names they choose with the
-		prefix <code>org.apache.harmony.<b>&lt;modulename&gt;</b></code>
+		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>
+		The following package name segements are <b>reserved</b> to indicate the meanings
+		defined below:</p>
+                                                <ul>
 			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>internal</b></code>
-			<p>
+        <p>
 				Packages with this prefix are implementation packages for use within
-				the given module.  Types and fields that are visible within these
+				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>
@@ -284,7 +284,7 @@
 			<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
+				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>
@@ -293,14 +293,13 @@
 				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
+		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>
+		Java binary compatibility</a>.
 	</p>
                             
       </td></tr>

Modified: incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html?view=diff&rev=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html (original)
+++ incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html Fri Nov  3 00:27:20 2006
@@ -36,7 +36,7 @@
             
             
             
-            <title>Apache Harmony - Framework for testing serialization</title>
+            <title>Apache Harmony - Framework for Testing Serialization</title>
 
                                 <link rel="Stylesheet" type="text/css" href="site.css"/>
         </head>
@@ -207,7 +207,7 @@
                                                                     <table  cellspacing="0" cellpadding="2" width="100%">
       <tr><td>
         <h1>
-          <a name="Framework for testing serialization">Framework for testing serialization</a>
+          <a name="Framework for Testing Serialization">Framework for Testing Serialization</a>
         </h1>
       </td></tr>
       <tr><td>
@@ -219,164 +219,150 @@
                                                 <p>
 		The framework for testing serialization is intended to simplify and formalize
 		development of serialization tests. This document contains guidelines for
-		creating tests and conventions for resource files.
+		creating tests and <a href="#conventions">conventions</a> for resource files.
 	</p>
                                                     
       <tr><td>
             <h2>
-          <a name="Guidelines for developing serialization tests">Guidelines for developing serialization tests</a>
+          <a name="Guidelines for Developing Serialization Tests">Guidelines for Developing Serialization Tests</a>
             </h2>
       </td></tr>
       <tr><td>
         
                                     <p>
-		The testing framework provides support class
+		The testing framework provides the support class
 		<code>org.apache.harmony.testframework.serialization.SerializationTest</code>
 		for serialization testing.
 	</p>
-                                                <p>
-	    <b>1) Compatibility testing</b><br />
-		Verifies that an object serialized on certified implementation is
-		correctly deserialized on Harmony implementation.<br /><br />
-		The support class provides 4 methods for compatibility testing:
+                                                <h3>Compatibility Testing</h3>
+                                                <p>Verifies that an object serialized on certified implementation is
+		correctly deserialized on Harmony implementation.<br />
+		The support class provides four methods for compatibility testing:
 		<ul><code>
 			<li>verifyGolden(TestCase, Object)</li>
 			<li>verifyGolden(TestCase, Object, <a href="#assert">SerializableAssert</a>)</li>
 			<li>verifyGolden(TestCase, Object[])</li>
 			<li>verifyGolden(TestCase, Object[], <a href="#assert">SerializableAssert</a>)</li>
-		</code></ul>
-		The first parameter <code>TestCase</code> is used to locate resource
-		file(s) that contains serialized object(s). The second parameter is an object
+		</code></ul></p>
+                                                <p>The first parameter <code>TestCase</code> is used to locate resource
+		file(s) that contains serialized object(s).<br />
+    The second parameter is an object
 		or an array of objects to be compared with object(s) deserialized from
-		resource file(s). And the third parameter is optional.<br /><br />
-		
-		So to create a <em>compatibility</em> test for selected class a developer should:
-		<ul>
+		resource file(s).<br />
+    The third parameter is optional.</p>
+                                                <p>To create a <em>compatibility</em> test for selected class, a developer should:</p>
+                                                <ul>
 			<li>
-			serialize object(s) on certified implementation, store serialized
-			form(s) in resource file(s) and place it(them) according to conventions
-			below
-			</li>
+			Serialize object(s) on certified implementation, store serialized
+			form(s) in resource file(s) and place it(them) according to the <a href="#conventions">
+       conventions</a> </li>
 			
 			<li>
-			add to an unit test a method: <code>testSerializationCompatibility</code>
+			Add the <code>testSerializationCompatibility</code> method to a unit test 
 			</li>
 			
 			<li>
-			invoke one of the above methods with corresponding arguments
+			Invoke one of the methods, mentioned above, with corresponding arguments
 			</li>
 		</ul>
-		
-		For example,
-		<pre>
-public void testSerializationCompatibility()
+                                                <p class="example">Example</p>
+                                                <pre>		
+    public void testSerializationCompatibility()
         throws Exception {
 
     SerializationTest.verifyGolden(this, new SomeSerializableClass());
 }
-		</pre>
-	</p>
-                                                <p>
-		<b>2) Self testing</b><br />
-		Verifies that an object can be smoothly serialized and deserialized on
-		Harmony implementation<br /><br />
-		The support class provides 4 methods for self-testing:
-		<ul><code>
+</pre>
+                                                <h3>Self-Testing</h3>
+                                                <p>Verifies that an object can be smoothly serialized and deserialized on
+		Harmony implementation.<br />
+		The support class provides four methods for self-testing:</p>
+                                                <ul><code>
 			<li>verifySelf(Object)</li>
 			<li>verifySelf(Object, <a href="#assert">SerializableAssert</a>)</li>
 			<li>verifySelf(Object[])</li>
 			<li>verifySelf(Object[], <a href="#assert">SerializableAssert</a>)</li>
 		</code></ul>
-		The provided object(s) is(are) serialized/deserialized and compared with
-		initial object(s).<br /><br />
-
-		So to create a <em>self</em> test for selected class a developer should:
-		<ul>
+                                                <p>The provided object(s) is(are) serialized/deserialized and compared with
+		initial object(s).</p>
+                                                <p>To create a <em>self</em> test for a selected class, a developer should:</p>
+                                                <ul>
 			<li>
-			add to an unit test a method: <code>testSerializationSelf</code>
+			Add the <code>testSerializationSelf</code> method to a unit test
 			</li>
 			
 			<li>
-			invoke one of the above methods with corresponding arguments
+			Invoke one of the methods with corresponding arguments
 			</li>
 		</ul>
+                                                <p class="example">Example</p>
+                                                <pre>  
+     public void testSerializationSelf() throws Exception {
 
-		For example,
-		<pre>
-public void testSerializationSelf() throws Exception {
-
-    SerializationTest.verifySelf(new SomeSerializableClass(),
-            new MyComparator());
+     SerializationTest.verifySelf(new SomeSerializableClass(),
+     new MyComparator());
 }
-		</pre>
-	</p>
-                                                <p>
-		<b>3) Negative testing</b><br />
-		<big><em>TBD</em></big>
-	</p>
-                                                <p>
-		<a name="assert"><big><em>Interface SerializableAssert</em></big></a><br />
-		A test has to implement the interface in case if class of object(s)
-		to be compared doesn't have equals(Object) method or the testing
-		framework can not find appropriate comparator. The interface has only
-		one method to be implemented:<br /><br />
-		<code>
-			void assertDeserialized(Serializable reference, Serializable test);
-		</code>
-	</p>
+</pre>
+                                                <h3>Negative Testing</h3>
+                                                <big><em>TBD</em></big>
+                                                <p class="class">Interface <a name="assert"><code>SerializableAssert</code></a></p>
+                                                <p> If a class of object(s) to be compared does not have 
+    equals(Object) method or the testing framework can not find appropriate comparator, a 
+    test has to implement the interface. The interface has only
+		one method to be implemented:</p>
+                                                <pre>void assertDeserialized(Serializable reference, Serializable test);</pre>
                             
       </td></tr>
        
                                                     
       <tr><td>
             <h2>
-          <a name="Placement and naming conventions for resource files">Placement and naming conventions for resource files</a>
+          <a name="Placement and Naming Conventions for Resource Files">Placement and Naming Conventions for Resource Files</a>
             </h2>
       </td></tr>
       <tr><td>
         
                                     <p>
-		The resource files should follow the next conventions:
-		
-		<ul>
+		The resource files should follow the next <a name="conventions">conventions</a>:</p>
+                                                <ul>
 			<li>Root folder for resource files is <code>&lt;module root&gt;/src/test/resources/serialization</code>
 			</li>
 			
-			<li>Relative path to a resource file <em>MUST</em> match a test's package name.
+			<li>Relative path to a resource file <em>MUST</em> match a test's package name
 			</li>
 			
-			<li>A resource file <em>MUST</em> start with a test's name.
+			<li>A resource file <em>MUST</em> start with a test's name
 			</li>
 			
-			<li>A resource file <em>MUST</em> contain keywords pointing out to testing scenario.
+			<li>A resource file <em>MUST</em> contain keywords pointing out to testing scenario
 				<ol>
 
 				<li><code>&lt;golden&gt;</code> keyword is used for files generated on RI
 				</li>
 
 				<li><code>&lt;harmony&gt;</code> keyword is used for files generated on
-				Harmony	implementation.
+				Harmony	implementation
 				</li>
 
 				<li><code>&lt;negative&gt;</code> keyword is used for files that contain
-				broken serial form.
+				broken serial form
 				</li>
 
 				</ol>
 			</li>
 			
-			<li>A resource file name <em>MUST</em> contain some index.<br />
-			<em>Note:</em> if there is only one file the index is not required
-			</li>
-
-			<li>Extension for resource files is 'ser'.
+			<li>A resource file name <em>MUST</em> contain some index
+      <p class="note">Note</p>
+        <p class="notetext">If only one file exists, the index is not required.</p>
+		 
 			</li>
 
-		</ul>
-		
-		For example, for test org.apache.harmony.tests.java.lang.SomeClassTest we have following:
-		<blockquote>
-		<pre>
+			<li>Extension for resource files is <code>ser</code>
+			
+  <p class="example">Example</p>
+		<p class="exampletext">For the test <code>org.apache.harmony.tests.java.lang.SomeClassTest</code>,
+      we have the following resource files:</p>
+    		<pre>
 modules/luni/src/test/resources/serialization
      |
      \---org/apache/harmony/tests/java/lang
@@ -387,10 +373,9 @@
               SomeClassTest.harmony.0.ser
               SomeClassTest.harmony.1.ser
               SomeClassTest.negative.ser
-		</pre>
-		</blockquote>
+		</pre></li>
 
-	</p>
+		</ul>
                             
       </td></tr>
        

Modified: incubator/harmony/standard/site/docs/subcomponents/classlibrary/testing.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/subcomponents/classlibrary/testing.html?view=diff&rev=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/classlibrary/testing.html (original)
+++ incubator/harmony/standard/site/docs/subcomponents/classlibrary/testing.html Fri Nov  3 00:27:20 2006
@@ -36,7 +36,7 @@
             
             
             
-            <title>Apache Harmony - Testing conventions in the Apache Harmony Classlib</title>
+            <title>Apache Harmony - Testing Conventions in the Apache Harmony Classlib</title>
 
                                 <link rel="Stylesheet" type="text/css" href="site.css"/>
         </head>
@@ -207,7 +207,7 @@
                                                                     <table  cellspacing="0" cellpadding="2" width="100%">
       <tr><td>
         <h1>
-          <a name="Testing conventions used in the Apache Harmony Class Library">Testing conventions used in the Apache Harmony Class Library</a>
+          <a name="Testing Conventions Used in the Apache Harmony Class Library">Testing Conventions Used in the Apache Harmony Class Library</a>
         </h1>
       </td></tr>
       <tr><td>
@@ -221,12 +221,12 @@
                 adapted/modified to reflect module specifics.
 	</p>
                                                 <p>
-		See also: <a href="ser_testing.html">Framework for testing serialization</a>
+		See also: <a href="ser_testing.html">Framework for Testing Serialization</a>
 	</p>
                                                     
       <tr><td>
             <h2>
-          <a name="Location of the tests in the directory tree">Location of the tests in the directory tree</a>
+          <a name="Location of the Tests in the Directory Tree">Location of the Tests in the Directory Tree</a>
             </h2>
       </td></tr>
       <tr><td>
@@ -234,97 +234,77 @@
                                     <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
+                classes are located under: </p>
+                                                <pre>&lt;modulename&gt;/src/test</pre>
+                                                <p>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>
+                tests that must pass on RI and all conformant implementations.</p>
+                                                <pre>&lt;modulename&gt;/src/test/<b>impl</b> - Harmony specific tests<br />
+&lt;modulename&gt;/src/test/<b>api</b> - Implementation-independent tests</pre>
+                                                <p>Special-purpose tests like stress tests or tests that require special configuration are 
+                separated from general-purpose tests.</p>
+                                                <pre>&lt;modulename&gt;/src/test/<b>stress</b></pre>
+                                                <p>Tests are not separated by functionality under test, for example, 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>
+                Classpath tests are separated from bootclasspath tests on a directory level:</p>
+                                                <pre>&lt;modulename&gt;/src/test/api/<b>java</b> - Classpath tests<br />
+&lt;modulename&gt;/src/test/api/<b>java.injected</b> - Bootclasspath tests</pre>
+                                                <p> Find more details <a href="#Package and Class Names for Different Types of the Tests">
+                 below</a>.</p>
+                                                <p>Some modules might have platform specific tests that are in the case separated on a directory 
+                level:</p>
+                                                <pre>&lt;modulename&gt;/src/test/api/<b>common</b><br />
+&lt;modulename&gt;/src/test/api/<b>windows</b><br />
+&lt;modulename&gt;/src/test/api/<b>linux</b></pre>
                             
       </td></tr>
        
                                                     
       <tr><td>
             <h2>
-          <a name="Package and class names for different types of the tests">Package and class names for different types of the tests</a>
+          <a name="Package and Class Names for Different Types of the Tests">Package and Class Names for Different Types of the Tests</a>
             </h2>
       </td></tr>
       <tr><td>
         
                                     <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
+		If the test is designed to be run from bootclasspath, then its package is the same
+                as the package of the class under the 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>
+		If the test is designed to be run from classpath then:</p>
+                                                <ol>
+                  <li>If the package under test belongs to a public package, for example, it 
+                  is a part of the API specification, then the test's package is: 
+			<pre>org.apache.harmony.&lt;modulename&gt;.tests.<b>&lt;package under test&gt;</b></pre>
+    <p class="example">Example</p>
+     
+			<pre>org.apache.harmony.luni.tests.<b>java.lang</b><br />
+org.apache.harmony.crypto.tests.<b>javax.crypto</b><br />
+org.apache.harmony.auth.tests.<b>org.ietf.jgss</b></pre>
+</li>
+    <li>If the package under test belongs to <code>org.apache.harmony</code> 
+    namespace so that class's package is:
+			<pre>org.apache.harmony.&lt;modulename&gt;.<b>&lt;rest of the package name&gt;</b></pre>
+                then the test's package is: 
+			<pre>org.apache.harmony.&lt;modulename&gt;.tests.<b>&lt;rest of the package name&gt;</b></pre> 
+    <p class="example">Example</p>
+      <p class="notetext">
+			<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</p>
+			
+</li></ol>
                                                 <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>
+   To avoid collision of test results for various type of tests, reflect a test type in a test name.</p>
+                                                <p class="example">Example</p>
+                                                <p class="notetext">To separate the <code>impl</code> test results from 
+    the <code>api</code> ones, the <code>impl</code> test names end with 
+                <code>_ImplTest</code>:<br />
+			<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></p>
                             
       </td></tr>
        

Modified: incubator/harmony/standard/site/xdocs/documentation/build_website.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/documentation/build_website.xml?view=diff&rev=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/xdocs/documentation/build_website.xml (original)
+++ incubator/harmony/standard/site/xdocs/documentation/build_website.xml Fri Nov  3 00:27:20 2006
@@ -31,7 +31,7 @@
 
 <subsection name="Building">
 	<p>
-		The following tools are required to build the Harmony website
+		The following tools are required to build the Harmony website:
 		
 		<ul>
 		    <li>
@@ -46,24 +46,25 @@
 		</ul>
 	</p>
 	
-	<p>
+
 		<ol>
 			<li>
-			   Download the website source from Harmony subversion repository
+			   Download the website source from Harmony subversion repository:</li>
 			   <pre>$ svn checkout https://svn.apache.org/repos/asf/incubator/harmony/standard/site</pre>
-			</li>
+		
 			
 			<li>
-			   Change into the site directory and run the default ant script target
-			  <pre>$ cd site</pre>
-			  <pre>$ ant</pre>
-			</li>
+			   Change into the site directory:
+     <pre>$ cd site</pre> </li>
+      <li>Run the default ant script target:</li>
+			 <pre>$ ant</pre>
+			
 	    </ol>
-	</p>
+
 	
 	<p>
-	  At this point, you have a complete generated website and documentation in the <i>site/docs</i>
-	   subdirectory.  Open the <i>index.html</i> page and start browsing.
+	  At this point, you have a complete generated website and documentation in the 
+    <code>site/docs</code> subdirectory. Open the <code>index.html</code> page and start browsing.
 	</p>
 
 </subsection>
@@ -71,13 +72,14 @@
 <subsection name="Making Changes">
 
   <p>
-    Making changes is straightforward.  All edits are made to the contents of the <i>xdocs/</i> 
-    subdirectory, and then rendered via the procedure above into the <i>docs/</i> directory.
-  </p>
+    Making changes is straightforward.  All edits are made to the contents of the <code>xdocs/</code> 
+    subdirectory, and then rendered via the procedure above into the <code>docs/</code> directory.
+  
+</p>
   
   <p>
-    If you are a Harmony committer, you can simply checkin your changes.  If you are not 
-    a committer, any updates and additions to the site are very welcome.  Please
+    If you are a Harmony committer, you can simply checkin your changes. If you are not 
+    a committer, any updates and additions to the site are very welcome. Please
     see our <a href="../get-involved.html">Get Involved</a> page for instructions
     on how to contribute your changes.
   </p>
@@ -88,31 +90,30 @@
 
   <p>
     If you are a Harmony Committer, you can commit your changes into SVN and then
-    publish to the project website.  Once the changes are in SVN, simply :
+    publish to the project website. Once the changes are in SVN, do the following:
   </p>
   
-  <p>
     <ol>
       <li>
-        SSH to minotaur.apache.org
+        SSH to <code>minotaur.apache.org</code>. Your login name will of course be your own.</li>
         <pre>$ ssh geirm@minotaur.apache.org </pre>
-        Your login name will of course be your own.
-      </li>
+        
       <li>
-        Go to the project website directory.
+        Go to the project website directory:</li>
         <pre>$ cd /www/incubator.apache.org/harmony/</pre>
-      </li>
+      
       <li>
-        Update the local copy.  There are two ways.  A simple
+        Update the local copy in one of two ways:
         <pre>$ svn update</pre>
-        will update the local copy.  If you need to delete the HTML and 
-        re-checout use 
-        <pre>$ `cat UPDATE`</pre>
-        as the UPDATE file has the command used to do a fresh svn checkout.
-      </li>
+        If you need to delete the HTML and 
+        re-checkout, use: 
+        <pre>$ `cat UPDATE`</pre></li>
+        <p class="note">Note</p>
+        <p class="notetext">The <code>UPDATE</code> file has the command performing a fresh svn checkout.</p> 
+     
         
     </ol>
-  </p>
+  
   
 </subsection>
 </section>

Modified: incubator/harmony/standard/site/xdocs/subcomponents/buildtest/index.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/buildtest/index.xml?view=diff&rev=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/buildtest/index.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/buildtest/index.xml Fri Nov  3 00:27:20 2006
@@ -30,16 +30,15 @@
 <p>
     The
     <a href="http://svn.apache.org/viewvc/incubator/harmony/enhanced/buildtest/">
-    'build-test framework'</a> is a simple configuration of
-    <a href="http://cruisecontrol.sourceforge.net/">Cruise Control</a>,
-    a framework for continuous build process.  It also includes all the
+      <i>build-test framework</i></a> is a simple configuration of
+    <a href="http://cruisecontrol.sourceforge.net/"><code>CruiseControl</code></a>,
+    a framework for continuous build process. It also includes all the
     necessary support to simplify installation.
 </p>
 
 <p>
-    Currently, the framework does these distinct tasks, in order :
-</p>
-
+    Currently, the framework does the following distinct tasks, in order,
+    and only when code changes in the repository:</p>
     <ol>
         <li>Update the source for the class library from SVN</li>
         <li>Get any new dependencies needed for building the class library</li>
@@ -48,21 +47,15 @@
         <li>Get and build any new dependencies needed for DRLVM</li>
         <li>Build and test the DRLVM</li>
     </ol>
+</section>
+   <section name="Setup and Configuration">
 
-    <p>
-        It does these tasks in-order, and only when code changes in the repository.
-    </p>
- </section>
-
-<section name="Setup and Configuration">
-
-    <strong>Pre-requisites</strong>
+  <subsection name="Prerequisites"> 
 
     <p>
-    Basically, you need the tools needed to build the Apache Harmony
-    components, like Java, Ant, C/C++ compilers, etc.  Please see
-    the other parts of the project for information on the necessary
-    toolchains.  You need the following software installed :
+    Basically, you need the same tools, as for building the Apache Harmony
+    components, like Java, Ant, C/C++ compilers, etc. Install the following 
+    software:
     </p>
 
     <ol>
@@ -70,91 +63,74 @@
         <li><a href="http://ant.apache.org/">Apache Ant</a></li>
         <li><a href="http;//subversion.tigris.org/">Subversion Client</a></li>
     </ol>
+  <p>Please see the other parts of the project for information on the necessary
+    toolchains.</p></subsection>
 
-    <strong>Setup</strong>
+  <subsection name="Setup">
+        <p>
+       Get the <code>/harmony/enhanced/buildtest/</code> part of the Apache
+       Harmony project via <code>zip</code> or <code>tgz</code> files. You also can 
+       check it out from the project Subversion repository:</p>
 
-    <p>
-       Get the /harmony/enhanced/buildtest/ part of the Apache
-       Harmony project.  If you are reading this, you either have
-       it via a zip or tgz, or have checked it out from the project
-       Subversion repository.  In the event that you don't have it
-       you can get it via subversion :
-    </p>
-
-    <blockquote>
-         svn co https://svn.apache.org/repos/asf/incubator/harmony/enhanced/buildtest/trunk
-    </blockquote>
+    <pre>svn co https://svn.apache.org/repos/asf/incubator/harmony/enhanced/buildtest/trunk</pre>
 
     <p>
-       With Java, Ant and SVN installed, change into the buildtest/trunk
-       directory and type
+       With Java, Ant and SVN installed, change into the <code>buildtest/trunk</code>
+       directory and type:
     </p>
 
-    <blockquote>
-          ant setup
-    </blockquote>
+    <pre>ant setup</pre>
 
     <p>
-       This should fetch CruiseControl, set it up with the Apache Harmony
-       configuration, and checkout the software to be built and tested
+       This command fetches <code>CruiseControl</code>, sets it up with the Apache Harmony
+       configuration, and checks out the software for building and testing 
        from Apache Harmony.
     </p>
 
     <p>
-       If you wish to have the tests run successfully, you need to do the
-       following manual steps for now :
+       To run the tests successfully, you need to do the
+       following manual steps for now:
     </p>
 
     <ol>
       <li>
-         build the classlib to create the deploy/jdk tree in classlib, first
-         fetching the dependencies
-        <blockquote>
-           cd cc/projects/classlib/trunk
-           ant fetch-depends
-           ant
-        </blockquote>
+         Build the classlib to create the <code>deploy/jdk</code> tree in classlib, 
+         first fetching the dependencies:
+        <pre>cd cc/projects/classlib/trunk
+ant fetch-depends
+ant</pre>
       </li>
       <li>
-         get the appropriate IBM J9 VM for your platform (this will go
-         away when DRLVM is good enough
+         Get the appropriate IBM J9 VM for your platform (this will go
+         away when DRLVM is good enough):
 
-         <blockquote>
-           http://www-128.ibm.com/developerworks/java/jdk/harmony/index.html
-         </blockquote>
+         <pre>http://www-128.ibm.com/developerworks/java/jdk/harmony/index.html</pre>
        </li>
 
         <li>
-         unpack the above-fetched J9 distribution into the jdk directory (as
-         the distro assumes it's dropped into the jdk directory...)
+         Unpack the above-fetched J9 distribution into the <code>jdk</code> directory (as
+         the distro assumes it is dropped into the<code>jdk</code> directory):
 
-        <blockquote>
-           cd cc/projects/classlib/trunk/deploy/jdk/ <br/>
-           tar zxf Harmony-vme-linux.IA32-v4.tar.gz
-        </blockquote>
+        <pre>cd cc/projects/classlib/trunk/deploy/jdk/
+tar zxf Harmony-vme-linux.IA32-v4.tar.gz</pre>
         </li>
 
     </ol>
-
-    <strong>Starting CruiseControl</strong>
+  </subsection>
+  <subsection name="Starting CruiseControl">
 
     <p>
-        To start the system, just type :
+        To start the system, type the following command in 
+        <code>buildtest/trunk</code>: 
     </p>
 
-     <blockquote>
-         ant
-     </blockquote>
-
-    <p>
-       in buildtest/trunk and that will launch CC with the full test set.
-       To check status, point your browser to
-    </p>
+     <pre>ant</pre>
 
-   <blockquote>
-       http://localhost:8080/
-   </blockquote>
+    <p>The given command launches <code>CruiseControl</code> with the full test set. 
+    To check status, point your browser to:</p>
 
+   <pre>http://localhost:8080/</pre>
+  </subsection>
 </section>
  </body>
  </document>

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=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml Fri Nov  3 00:27:20 2006
@@ -21,16 +21,16 @@
 <document>
 
  <properties>
-  <title>Package naming conventions in the Apache Harmony Classlib</title>
+  <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">
+<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>
+		<a href="http://wiki.eclipse.org/index.php/Naming_Conventions">the Eclipse package naming convention</a>
 		documentation.</em></small>
 	</p>
 	<p>
@@ -41,39 +41,40 @@
 	</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
+		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">
+<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>
+		The module name immediately follows the <code>org.apache.harmony</code> prefix.</p>
+			<pre>org.apache.harmony.<b>&lt;module&gt;</b></pre>
+			
+    <p class="example">
+      Example
+    </p>
+    <p class="exampletext">
+			<pre>org.apache.harmony.luni
+org.apache.harmony.security</pre>
+			
 	</p>
 </subsection>
 
-<subsection name="Package names within a module">
+<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>
+		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:
+		The following package name segements are <b>reserved</b> to indicate the meanings
+		defined below:</p>
 		<ul>
 			<li><code>org.apache.harmony.&lt;modulename&gt;.<b>internal</b></code>
-			<p>
+        <p>
 				Packages with this prefix are implementation packages for use within
-				the given module.  Types and fields that are visible within these
+				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>
@@ -87,7 +88,7 @@
 			<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
+				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>
@@ -96,14 +97,13 @@
 				be referenced from any module.
 			</p></li>
 		</ul>
-	</p>
-	<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
+		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>
+		Java binary compatibility</a>.
 	</p>
 </subsection>
 </section>

Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml?view=diff&rev=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml Fri Nov  3 00:27:20 2006
@@ -21,13 +21,13 @@
 <document>
 
  <properties>
-  <title>Framework for testing serialization</title>
+  <title>Framework for Testing Serialization</title>
   <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
  </properties>
 
 <body>
 
-<section name="Framework for testing serialization">
+<section name="Framework for Testing Serialization">
 	<p>
 		<big><em>The framework for testing serialization is currently PROPOSED and being 
 		discussed on the development mailing list <code>harmony-dev@incubator.apache.org</code>.  
@@ -36,150 +36,151 @@
 	<p>
 		The framework for testing serialization is intended to simplify and formalize
 		development of serialization tests. This document contains guidelines for
-		creating tests and conventions for resource files.
+		creating tests and <a href="#conventions">conventions</a> for resource files.
 	</p>
 
-<subsection name="Guidelines for developing serialization tests">
+<subsection name="Guidelines for Developing Serialization Tests">
 	<p>
-		The testing framework provides support class
+		The testing framework provides the support class
 		<code>org.apache.harmony.testframework.serialization.SerializationTest</code>
 		for serialization testing.
 	</p>
-	<p>
-	    <b>1) Compatibility testing</b><br/>
-		Verifies that an object serialized on certified implementation is
-		correctly deserialized on Harmony implementation.<br/><br/>
-		The support class provides 4 methods for compatibility testing:
+    <h3>Compatibility Testing</h3>
+		<p>Verifies that an object serialized on certified implementation is
+		correctly deserialized on Harmony implementation.<br/>
+		The support class provides four methods for compatibility testing:
 		<ul><code>
 			<li>verifyGolden(TestCase, Object)</li>
 			<li>verifyGolden(TestCase, Object, <a href="#assert">SerializableAssert</a>)</li>
 			<li>verifyGolden(TestCase, Object[])</li>
 			<li>verifyGolden(TestCase, Object[], <a href="#assert">SerializableAssert</a>)</li>
-		</code></ul>
-		The first parameter <code>TestCase</code> is used to locate resource
-		file(s) that contains serialized object(s). The second parameter is an object
+		</code></ul></p>
+		<p>The first parameter <code>TestCase</code> is used to locate resource
+		file(s) that contains serialized object(s).<br/>
+    The second parameter is an object
 		or an array of objects to be compared with object(s) deserialized from
-		resource file(s). And the third parameter is optional.<br/><br/>
+		resource file(s).<br/>
+    The third parameter is optional.</p>
 		
-		So to create a <em>compatibility</em> test for selected class a developer should:
+		<p>To create a <em>compatibility</em> test for selected class, a developer should:</p>
 		<ul>
 			<li>
-			serialize object(s) on certified implementation, store serialized
-			form(s) in resource file(s) and place it(them) according to conventions
-			below
-			</li>
+			Serialize object(s) on certified implementation, store serialized
+			form(s) in resource file(s) and place it(them) according to the <a href="#conventions">
+       conventions</a> </li>
 			
 			<li>
-			add to an unit test a method: <code>testSerializationCompatibility</code>
+			Add the <code>testSerializationCompatibility</code> method to a unit test 
 			</li>
 			
 			<li>
-			invoke one of the above methods with corresponding arguments
+			Invoke one of the methods, mentioned above, with corresponding arguments
 			</li>
 		</ul>
-		
-		For example,
-		<pre>
-public void testSerializationCompatibility()
+
+  <p class="example">Example</p>
+  
+<pre>		
+    public void testSerializationCompatibility()
         throws Exception {
 
     SerializationTest.verifyGolden(this, new SomeSerializableClass());
 }
-		</pre>
-	</p>
-	<p>
-		<b>2) Self testing</b><br/>
-		Verifies that an object can be smoothly serialized and deserialized on
-		Harmony implementation<br/><br/>
-		The support class provides 4 methods for self-testing:
+</pre>
+		
+	
+    	<h3>Self-Testing</h3>
+		<p>Verifies that an object can be smoothly serialized and deserialized on
+		Harmony implementation.<br/>
+		The support class provides four methods for self-testing:</p>
 		<ul><code>
 			<li>verifySelf(Object)</li>
 			<li>verifySelf(Object, <a href="#assert">SerializableAssert</a>)</li>
 			<li>verifySelf(Object[])</li>
 			<li>verifySelf(Object[], <a href="#assert">SerializableAssert</a>)</li>
 		</code></ul>
-		The provided object(s) is(are) serialized/deserialized and compared with
-		initial object(s).<br/><br/>
+		<p>The provided object(s) is(are) serialized/deserialized and compared with
+		initial object(s).</p>
 
-		So to create a <em>self</em> test for selected class a developer should:
+		<p>To create a <em>self</em> test for a selected class, a developer should:</p>
 		<ul>
 			<li>
-			add to an unit test a method: <code>testSerializationSelf</code>
+			Add the <code>testSerializationSelf</code> method to a unit test
 			</li>
 			
 			<li>
-			invoke one of the above methods with corresponding arguments
+			Invoke one of the methods with corresponding arguments
 			</li>
 		</ul>
 
-		For example,
-		<pre>
-public void testSerializationSelf() throws Exception {
+  <p class="example">Example</p>
+     <pre>  
+     public void testSerializationSelf() throws Exception {
 
-    SerializationTest.verifySelf(new SomeSerializableClass(),
-            new MyComparator());
+     SerializationTest.verifySelf(new SomeSerializableClass(),
+     new MyComparator());
 }
-		</pre>
-	</p>
-	<p>
-		<b>3) Negative testing</b><br/>
+</pre>
+    
+
+  <h3>Negative Testing</h3>
 		<big><em>TBD</em></big>
-	</p>
-	<p>
-		<a name="assert"><big><em>Interface SerializableAssert</em></big></a><br/>
-		A test has to implement the interface in case if class of object(s)
-		to be compared doesn't have equals(Object) method or the testing
-		framework can not find appropriate comparator. The interface has only
-		one method to be implemented:<br/><br/>
-		<code>
-			void assertDeserialized(Serializable reference, Serializable test);
-		</code>
-	</p>
+
+
+    <p class="class">Interface <a name="assert"><code>SerializableAssert</code></a></p>
+    <p> If a class of object(s) to be compared does not have 
+    equals(Object) method or the testing framework can not find appropriate comparator, a 
+    test has to implement the interface. The interface has only
+		one method to be implemented:</p>
+		
+      <pre>void assertDeserialized(Serializable reference, Serializable test);</pre>
+		
+	
 </subsection>
 
-<subsection name="Placement and naming conventions for resource files">
+<subsection name="Placement and Naming Conventions for Resource Files">
 	<p>
-		The resource files should follow the next conventions:
+		The resource files should follow the next <a name="conventions">conventions</a>:</p>
 		
 		<ul>
 			<li>Root folder for resource files is <code>&lt;module root&gt;/src/test/resources/serialization</code>
 			</li>
 			
-			<li>Relative path to a resource file <em>MUST</em> match a test's package name.
+			<li>Relative path to a resource file <em>MUST</em> match a test's package name
 			</li>
 			
-			<li>A resource file <em>MUST</em> start with a test's name.
+			<li>A resource file <em>MUST</em> start with a test's name
 			</li>
 			
-			<li>A resource file <em>MUST</em> contain keywords pointing out to testing scenario.
+			<li>A resource file <em>MUST</em> contain keywords pointing out to testing scenario
 				<ol>
 
 				<li><code>&lt;golden&gt;</code> keyword is used for files generated on RI
 				</li>
 
 				<li><code>&lt;harmony&gt;</code> keyword is used for files generated on
-				Harmony	implementation.
+				Harmony	implementation
 				</li>
 
 				<li><code>&lt;negative&gt;</code> keyword is used for files that contain
-				broken serial form.
+				broken serial form
 				</li>
 
 				</ol>
 			</li>
 			
-			<li>A resource file name <em>MUST</em> contain some index.<br/>
-			<em>Note:</em> if there is only one file the index is not required
+			<li>A resource file name <em>MUST</em> contain some index
+      <p class="note">Note</p>
+        <p class="notetext">If only one file exists, the index is not required.</p>
+		 
 			</li>
 
-			<li>Extension for resource files is 'ser'.
-			</li>
-
-		</ul>
-		
-		For example, for test org.apache.harmony.tests.java.lang.SomeClassTest we have following:
-		<blockquote>
-		<pre>
+			<li>Extension for resource files is <code>ser</code>
+			
+  <p class="example">Example</p>
+		<p class="exampletext">For the test <code>org.apache.harmony.tests.java.lang.SomeClassTest</code>,
+      we have the following resource files:</p>
+    		<pre>
 modules/luni/src/test/resources/serialization
      |
      \---org/apache/harmony/tests/java/lang
@@ -190,10 +191,9 @@
               SomeClassTest.harmony.0.ser
               SomeClassTest.harmony.1.ser
               SomeClassTest.negative.ser
-		</pre>
-		</blockquote>
+		</pre></li>
 
-	</p>		
+		</ul>
 </subsection>
 </section>
 </body>

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=470718&r1=470717&r2=470718
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/testing.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/testing.xml Fri Nov  3 00:27:20 2006
@@ -21,13 +21,13 @@
 <document>
 
  <properties>
-  <title>Testing conventions in the Apache Harmony Classlib</title>
+  <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">
+<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.
@@ -38,96 +38,91 @@
                 adapted/modified to reflect module specifics.
 	</p>
 	<p>
-		See also: <a href="ser_testing.html">Framework for testing serialization</a>
+		See also: <a href="ser_testing.html">Framework for Testing Serialization</a>
 	</p>
 
-<subsection name="Location of the tests in the directory tree">
+<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
+                classes are located under: </p>
+			<pre>&lt;modulename&gt;/src/test</pre>
+		<p>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 that must pass on RI and all conformant implementations.</p> 
+			
+				<pre>&lt;modulename&gt;/src/test/<b>impl</b> - Harmony specific tests<br/>
+&lt;modulename&gt;/src/test/<b>api</b> - Implementation-independent tests</pre>
+			
+                <p>Special-purpose tests like stress tests or tests that require special configuration are 
+                separated from general-purpose tests.</p>
+			<pre>&lt;modulename&gt;/src/test/<b>stress</b></pre>
+			
 
-                Tests are not separated by functionality under test, e.g. tests against <code>clone()</code>
+               <p>Tests are not separated by functionality under test, for example, 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>
+                Classpath tests are separated from bootclasspath tests on a directory level:</p>
+			
+				<pre>&lt;modulename&gt;/src/test/api/<b>java</b> - Classpath tests<br/>
+&lt;modulename&gt;/src/test/api/<b>java.injected</b> - Bootclasspath tests</pre>
+			
+               <p> Find more details <a href="#Package and Class Names for Different Types of the Tests">
+                 below</a>.</p>
+
+
+                <p>Some modules might have platform specific tests that are in the case separated on a directory 
+                level:</p>
+			
+				<pre>&lt;modulename&gt;/src/test/api/<b>common</b><br/>
+&lt;modulename&gt;/src/test/api/<b>windows</b><br/>
+&lt;modulename&gt;/src/test/api/<b>linux</b></pre>
+			
+	
 </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>
+<subsection name="Package and Class Names for Different Types of the Tests">
 	<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>
-
-
+		If the test is designed to be run from bootclasspath, then its package is the same
+                as the package of the class under the test.
 	</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>
+		If the test is designed to be run from classpath then:</p>
+                <ol>
+                  <li>If the package under test belongs to a public package, for example, it 
+                  is a part of the API specification, then the test's package is: 
+			<pre>org.apache.harmony.&lt;modulename&gt;.tests.<b>&lt;package under test&gt;</b></pre>
+    <p class="example">Example</p>
+     
+			<pre>org.apache.harmony.luni.tests.<b>java.lang</b><br/>
+org.apache.harmony.crypto.tests.<b>javax.crypto</b><br/>
+org.apache.harmony.auth.tests.<b>org.ietf.jgss</b></pre>
+</li>
+    <li>If the package under test belongs to <code>org.apache.harmony</code> 
+    namespace so that class's package is:
+			<pre>org.apache.harmony.&lt;modulename&gt;.<b>&lt;rest of the package name&gt;</b></pre>
+                then the test's package is: 
+			<pre>org.apache.harmony.&lt;modulename&gt;.tests.<b>&lt;rest of the package name&gt;</b></pre> 
+    <p class="example">Example</p>
+      <p class="notetext">
+			<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</p>
+			
+</li></ol>
+
+	
+	<p>
+   To avoid collision of test results for various type of tests, reflect a test type in a test name.</p>
+   <p class="example">Example</p>
+    <p class="notetext">To separate the <code>impl</code> test results from 
+    the <code>api</code> ones, the <code>impl</code> test names end with 
+                <code>_ImplTest</code>:<br/>
+			<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></p>
 
-	</p>
+	
 </subsection>
 </section>
 </body>



Mime
View raw message