harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hinde...@apache.org
Subject svn commit: r574189 [4/10] - in /harmony/standard/site: docs/ docs/documentation/milestones/ docs/subcomponents/drlvm/ xdocs/ xdocs/documentation/ xdocs/stylesheets/ xdocs/subcomponents/classlibrary/ xdocs/subcomponents/drlvm/
Date Mon, 10 Sep 2007 09:33:40 GMT
Propchange: harmony/standard/site/docs/subcomponents/drlvm/cp-verifier.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: harmony/standard/site/xdocs/documentation/conventions.xml
URL: http://svn.apache.org/viewvc/harmony/standard/site/xdocs/documentation/conventions.xml?rev=574189&r1=574188&r2=574189&view=diff
==============================================================================
--- harmony/standard/site/xdocs/documentation/conventions.xml (original)
+++ harmony/standard/site/xdocs/documentation/conventions.xml Mon Sep 10 02:33:37 2007
@@ -1,109 +1,109 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!--    Licensed to the Apache Software Foundation (ASF) under one or more
-    contributor license agreements. See the NOTICE file distributed with
-    this work for additional information regarding copyright ownership.
-    The ASF licenses this file to You 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>Conventions</title>
-    <author email="dev@harmony.apache.org">Harmony Documentation Team</author>
-
-  </properties>
-
-  <body>
-    <section name="Conventions">
-      <p>The DRL (dynamic run-time layer) documentation set uses the following conventions.</p>
-
-      <table>
-        <tr>
-          <th class="TableHeading">Convention </th>
-          <th class="TableHeading"> Explanation</th>
-          <th class="TableHeading">Example</th>
-        </tr>
-        <tr>
-          <td class="TableCell"> <code> monospace </code> </td>
-          <td class="TableCell">Filenames</td>
-          <td class="TableCell"> <code> ippsapi.h </code> </td>
-         </tr>
-        <tr>
-          <td class="TableCell"> <code> monospace </code> </td>
-          <td class="TableCell">Directory names and pathnames </td>
-          <td class="TableCell"> <code> \alt\include</code> </td>
-        </tr>
-        <tr>
-          <td class="TableCell"> <code> monospace </code> </td>
-          <td class="TableCell"> Commands and command-line options</td>
-          <td class="TableCell"> <code> ecl -O2 </code> </td>
-        </tr>
-        <tr>
-          <td class="TableCell"> <code> monospace </code> </td>
-          <td class="TableCell">Function names, methods, classes, data structures in
-            running text</td>
-          <td class="TableCell">Use the <code> okCreateObjs </code> function to ...</td>
-        </tr>
-        <tr>
-          <td class="TableCell"> <code> monospace </code> </td>
-          <td class="TableCell"> Parameters or other placeholders </td>
-          <td class="TableCell"> <code> ippiMalloc(int widthPixels, ...)<br/>
-                    int* pStepBytes </code> </td>
-        </tr>
-        <tr>
-          <td class="TableCell">
-            <code>
-              <b>monospace bold</b>
-            </code>
-          </td>
-          <td class="TableCell">User input</td>
-          <td class="TableCell">
-            <code>
-              [c:] <b> dir</b>
-            </code>
-          </td>
-        </tr>
-        <tr>
-          <td class="TableCell">
-            <i>italics </i>
-          </td>
-          <td class="TableCell"> Emphasis; introducing or defining terms</td>
-          <td class="TableCell">
-            The term <i> access</i> takes as its subject ...
-          </td>
-        </tr>
-        <tr>
-          <td class="TableCell"> [ ]</td>
-          <td class="TableCell"> Optional items</td>
-          <td class="TableCell">
-            <code> -Fa[c]</code> Indicates these command-line
-            options: <code> -Fa</code> and <code> -Fac</code>
-          </td>
-        </tr>
-        <tr>
-          <td class="TableCell"> { | }  </td>
-          <td class="TableCell">
-            Choice of one item from a selection of two or more
-            items.
-          </td>
-          <td class="TableCell">
-            <code> -aX{K | W | P}</code> Indicates these command-line
-            options:<br/>
-              <code>  -aXK <br/>
-                  -aXW <br/> -aXP</code></td>
-          </tr>
-      </table>
-
-    </section>
-  </body>
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!--    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements. See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You 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>Conventions</title>
+    <author email="dev@harmony.apache.org">Harmony Documentation Team</author>
+
+  </properties>
+
+  <body>
+    <section name="Conventions">
+      <p>The DRL (dynamic run-time layer) documentation set uses the following conventions.</p>
+
+      <table>
+        <tr>
+          <th class="TableHeading">Convention </th>
+          <th class="TableHeading"> Explanation</th>
+          <th class="TableHeading">Example</th>
+        </tr>
+        <tr>
+          <td class="TableCell"> <code> monospace </code> </td>
+          <td class="TableCell">Filenames</td>
+          <td class="TableCell"> <code> ippsapi.h </code> </td>
+         </tr>
+        <tr>
+          <td class="TableCell"> <code> monospace </code> </td>
+          <td class="TableCell">Directory names and pathnames </td>
+          <td class="TableCell"> <code> \alt\include</code> </td>
+        </tr>
+        <tr>
+          <td class="TableCell"> <code> monospace </code> </td>
+          <td class="TableCell"> Commands and command-line options</td>
+          <td class="TableCell"> <code> ecl -O2 </code> </td>
+        </tr>
+        <tr>
+          <td class="TableCell"> <code> monospace </code> </td>
+          <td class="TableCell">Function names, methods, classes, data structures in
+            running text</td>
+          <td class="TableCell">Use the <code> okCreateObjs </code> function to ...</td>
+        </tr>
+        <tr>
+          <td class="TableCell"> <code> monospace </code> </td>
+          <td class="TableCell"> Parameters or other placeholders </td>
+          <td class="TableCell"> <code> ippiMalloc(int widthPixels, ...)<br/>
+                    int* pStepBytes </code> </td>
+        </tr>
+        <tr>
+          <td class="TableCell">
+            <code>
+              <b>monospace bold</b>
+            </code>
+          </td>
+          <td class="TableCell">User input</td>
+          <td class="TableCell">
+            <code>
+              [c:] <b> dir</b>
+            </code>
+          </td>
+        </tr>
+        <tr>
+          <td class="TableCell">
+            <i>italics </i>
+          </td>
+          <td class="TableCell"> Emphasis; introducing or defining terms</td>
+          <td class="TableCell">
+            The term <i> access</i> takes as its subject ...
+          </td>
+        </tr>
+        <tr>
+          <td class="TableCell"> [ ]</td>
+          <td class="TableCell"> Optional items</td>
+          <td class="TableCell">
+            <code> -Fa[c]</code> Indicates these command-line
+            options: <code> -Fa</code> and <code> -Fac</code>
+          </td>
+        </tr>
+        <tr>
+          <td class="TableCell"> { | }  </td>
+          <td class="TableCell">
+            Choice of one item from a selection of two or more
+            items.
+          </td>
+          <td class="TableCell">
+            <code> -aX{K | W | P}</code> Indicates these command-line
+            options:<br/>
+              <code>  -aXK <br/>
+                  -aXW <br/> -aXP</code></td>
+          </tr>
+      </table>
+
+    </section>
+  </body>
 </document>

Propchange: harmony/standard/site/xdocs/documentation/conventions.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: harmony/standard/site/xdocs/documentation/dev_eclipse.xml
URL: http://svn.apache.org/viewvc/harmony/standard/site/xdocs/documentation/dev_eclipse.xml?rev=574189&r1=574188&r2=574189&view=diff
==============================================================================
--- harmony/standard/site/xdocs/documentation/dev_eclipse.xml (original)
+++ harmony/standard/site/xdocs/documentation/dev_eclipse.xml Mon Sep 10 02:33:37 2007
@@ -1,244 +1,244 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!--
-
-    Licensed to the Apache Software Foundation (ASF) under one or more
-    contributor license agreements.  See the NOTICE file distributed with
-    this work for additional information regarding copyright ownership.
-    The ASF licenses this file to You 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="dev@harmony.apache.org">Harmony Documentation Team</author>
- </properties>
-
-<body>
-  <section name="Introduction">
-    <p>
-      The current page provides instructions on how to set up Eclipse to develop Java code
-      in Apache Harmony, with sections for both DRLVM and class library development.
-    </p>
-    <p>
-      DRLVM specific instructions are only emerging, while class library specific
-      instructions are in two sets: the <a href="#fastpath">fast path</a>
-      for people 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 novices who want to follow the details of a setup and see a brief
-      development example.
-    </p>
-    <p>
-      All instructions assume you satisfy the same Eclipse-based
-      development prerequsities, as described in the following section.
-    </p>
-    <subsection name="Prerequisites">
-      <p>
-        To develop Apache Harmony Java code with Eclipse JDT, you need:
-      </p>
-      <ol>
-        <li>
-          Eclipse: version 3.2 or later, from
-          <a href="http://download.eclipse.org">eclipse.org</a>
-        </li>
-        <li>
-          A Subversion plug-in: Either Subclipse from <a href="http://subclipse.tigris.org/">
-            tigris.org
-          </a> or Subversive from <a href="http://www.polarion.org">
-            polarion.org
-          </a>
-        </li>
-      </ol>
-      
-      <p>
-      Optionally, you may wish to use one of the external, production-grade virtual machines
-      that work with the Apache Harmony class library.  These can be found on our 
-      <a href="../related.html">Other Projects</a> page.
-      </p>
-      
-    </subsection>
-    <subsection name="Getting the Code">
-      <p>
-        Next you will need the code to work with. <i>For class library development</i>,
-        you will need a compatible VM, such as DRLVM or IBM virtual machine (the latter
-        available under a non-open source, binary evaluation license). Install the VM following the 
-        instructions that accompany that VM in the same location as the class libraries build (or the
-        location you will be building to if you are building the class libararies yourself).
-        <br />
-        You will also need a class libraries build if you want to work
-        on an individual module. 
-       </p>
-      <p>Analogously, you will need the class libraries for <i>DRLVM development</i>.
-        Follow one of these ways depending on your needs:
-      </p>
-      <ul>
-        <li>
-          <b>Get a pre-built snapshot</b> from the
-          <a href="http://people.apache.org/builds/harmony/snapshots/">download page</a>.
-        </li>
-        <li>
-          <b>Download the source code</b> to be built manually. For that, create an SVN repository location
-          using the URL:
-          <pre>
-///for the class libraries
-https://svn.apache.org/repos/asf/harmony/enhanced/classlib
-
-///for DRLVM
-https://svn.apache.org/repos/asf/harmony/enhanced/drlvm</pre>
-          Check out the code from SVN selecting <b>Checkout...</b> from the context menu of <code>trunk</code>.
-        </li>
-      </ul>
-    </subsection>
-  </section>
-<section name="DRLVM Development">
-<a name="drlvm"/>
-      <p>For details on how to build DRLVM and other related documentation, please see
-      the <a href="../subcomponents/drlvm/index.html">DRLVM web pages</a>.
-    </p>
-</section>
-
-<section name="Class Library Development: 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 prerequisites</a>
-    in place.  Then if you are using Linux start Eclipse as normal with the arguments 
-    <code>-vmargs -Dpde.jreProfile=none -Dpde.allowCycles=true</code> and skip to step 4. If
-    you are using Windows do the following:</p>
-    <ol>
-      <li>Copy the <code>vsvars32.bat</code> file from your Visual Studio install directory
-        to any convenient location. If you have chosen the defaults when installing, you 
-        will find the given file in the <code>
-          C:\Program Files\Microsoft Visual Studio.NET 2003\Common7\Tools</code> directory.</li> 
-         <li>Edit the <code>vsvars32.bat</code> file adding the following line right after the 
-        last line beginning with <code>@set...</code>: 
-        <pre>start C:\...\eclipse\eclipse.exe -vmargs -Xmx512M -Dpde.jreProfile=none -Dpde.allowCycles=true</pre>
-      In the line above, <code>"..."</code> is the path to your Eclipse installation directory.
-          
-        <p class="note">Note</p>
-      <p class="notetext">Using <code>-vmargs -Xmx512M</code> is optional, 
-      but helpful to stop Eclipse running out of memory.</p></li>
-         <li>To start Eclipse, double click on the <code>vsvars32.bat</code> file.
-        </li>
-
-      <li>
-        Configure the following settings in <b>Window</b> &gt; <b>Preferences</b>:
-      </li>
-        <ul>
-          <li>Change the Java compiler settings:
-            <ol>
-              <li>In the <b>Java</b> &gt; <b>Compiler</b> preferences ensure the
-                <b>Compiler compliance level</b> is set to
-                <b>1.4</b>.
-            </li>
-              <li>In the <b>Java</b> &gt; <b>Compiler</b> &gt; <b>Building</b> preferences,
-                open the <b>Build Path Problems</b> section
-                and change <b>Circular Dependencies</b> from
-                <b>Error</b> to <b>Warning</b>.
-            
-            </li>
-            </ol></li>
-          <li>Change the PDE settings:
-            <ol>
-              <li>In the <b>Plug-in Development</b> &gt; <b>Compilers</b> preferences
-              change <b>Unresolved Dependencies</b> from
-                <b>Error</b> to <b>Warning</b>.
-            </li>
-              <li>In the <b>Plug-in Development</b> &gt; <b>Target Platform</b>
-                preferences, change the <b>Location</b> box to be the
-                <code>jre/lib/boot</code> directory of the classlib snapshot.</li>
-            </ol></li>
-        </ul>
-      <li>Copy the <code>ecj_3.2.jar</code> file into the 
-      <code>...\eclipse\plugins\org.apache.ant_1.6.5\lib</code> directory.</li>
-      <li>To include the given file, configure the following Ant settings in 
-      <b>Window</b> &gt; <b>Preferences</b> &gt; <b>Ant</b> &gt; <b>Runtime</b>:
-    </li>
-      <ul>
-        <li>Select <b>Global Entries</b>
-      </li>
-        <li>Select <b>Add External Jars</b>
-    </li>
-        <li>Add the <code>ecj_3.2.jar</code> file from
-          the <code>org.apache.ant_1.6.5\lib</code> directory.
-        </li>
-        </ul>
-    </ol>
-  
-  
-</subsection>
-
-<subsection name="Developing and Testing 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
-        <code>trunk &gt; modules</code>. Select
-        <code>nio</code> and from the context menu select
-        <b>Checkout...</b>, and on the checkout dialog box click <b>Finish</b>.</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
-            <code>JUNIT JAR</code> 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="Class Library Development: Step-by-Step Guide">
-<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 -Dpde.allowCycles=true</pre>
-    We <a href="dev_eclipse_movie.html">
-    pick up the story here...</a> (<em>Warning 8Mb flash download!</em>)
-  </p>
-</section>
-
-</body>
-</document>
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You 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="dev@harmony.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+<body>
+  <section name="Introduction">
+    <p>
+      The current page provides instructions on how to set up Eclipse to develop Java code
+      in Apache Harmony, with sections for both DRLVM and class library development.
+    </p>
+    <p>
+      DRLVM specific instructions are only emerging, while class library specific
+      instructions are in two sets: the <a href="#fastpath">fast path</a>
+      for people 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 novices who want to follow the details of a setup and see a brief
+      development example.
+    </p>
+    <p>
+      All instructions assume you satisfy the same Eclipse-based
+      development prerequsities, as described in the following section.
+    </p>
+    <subsection name="Prerequisites">
+      <p>
+        To develop Apache Harmony Java code with Eclipse JDT, you need:
+      </p>
+      <ol>
+        <li>
+          Eclipse: version 3.2 or later, from
+          <a href="http://download.eclipse.org">eclipse.org</a>
+        </li>
+        <li>
+          A Subversion plug-in: Either Subclipse from <a href="http://subclipse.tigris.org/">
+            tigris.org
+          </a> or Subversive from <a href="http://www.polarion.org">
+            polarion.org
+          </a>
+        </li>
+      </ol>
+      
+      <p>
+      Optionally, you may wish to use one of the external, production-grade virtual machines
+      that work with the Apache Harmony class library.  These can be found on our 
+      <a href="../related.html">Other Projects</a> page.
+      </p>
+      
+    </subsection>
+    <subsection name="Getting the Code">
+      <p>
+        Next you will need the code to work with. <i>For class library development</i>,
+        you will need a compatible VM, such as DRLVM or IBM virtual machine (the latter
+        available under a non-open source, binary evaluation license). Install the VM following the 
+        instructions that accompany that VM in the same location as the class libraries build (or the
+        location you will be building to if you are building the class libararies yourself).
+        <br />
+        You will also need a class libraries build if you want to work
+        on an individual module. 
+       </p>
+      <p>Analogously, you will need the class libraries for <i>DRLVM development</i>.
+        Follow one of these ways depending on your needs:
+      </p>
+      <ul>
+        <li>
+          <b>Get a pre-built snapshot</b> from the
+          <a href="http://people.apache.org/builds/harmony/snapshots/">download page</a>.
+        </li>
+        <li>
+          <b>Download the source code</b> to be built manually. For that, create an SVN repository location
+          using the URL:
+          <pre>
+///for the class libraries
+https://svn.apache.org/repos/asf/harmony/enhanced/classlib
+
+///for DRLVM
+https://svn.apache.org/repos/asf/harmony/enhanced/drlvm</pre>
+          Check out the code from SVN selecting <b>Checkout...</b> from the context menu of <code>trunk</code>.
+        </li>
+      </ul>
+    </subsection>
+  </section>
+<section name="DRLVM Development">
+<a name="drlvm"/>
+      <p>For details on how to build DRLVM and other related documentation, please see
+      the <a href="../subcomponents/drlvm/index.html">DRLVM web pages</a>.
+    </p>
+</section>
+
+<section name="Class Library Development: 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 prerequisites</a>
+    in place.  Then if you are using Linux start Eclipse as normal with the arguments 
+    <code>-vmargs -Dpde.jreProfile=none -Dpde.allowCycles=true</code> and skip to step 4. If
+    you are using Windows do the following:</p>
+    <ol>
+      <li>Copy the <code>vsvars32.bat</code> file from your Visual Studio install directory
+        to any convenient location. If you have chosen the defaults when installing, you 
+        will find the given file in the <code>
+          C:\Program Files\Microsoft Visual Studio.NET 2003\Common7\Tools</code> directory.</li> 
+         <li>Edit the <code>vsvars32.bat</code> file adding the following line right after the 
+        last line beginning with <code>@set...</code>: 
+        <pre>start C:\...\eclipse\eclipse.exe -vmargs -Xmx512M -Dpde.jreProfile=none -Dpde.allowCycles=true</pre>
+      In the line above, <code>"..."</code> is the path to your Eclipse installation directory.
+          
+        <p class="note">Note</p>
+      <p class="notetext">Using <code>-vmargs -Xmx512M</code> is optional, 
+      but helpful to stop Eclipse running out of memory.</p></li>
+         <li>To start Eclipse, double click on the <code>vsvars32.bat</code> file.
+        </li>
+
+      <li>
+        Configure the following settings in <b>Window</b> &gt; <b>Preferences</b>:
+      </li>
+        <ul>
+          <li>Change the Java compiler settings:
+            <ol>
+              <li>In the <b>Java</b> &gt; <b>Compiler</b> preferences ensure the
+                <b>Compiler compliance level</b> is set to
+                <b>1.4</b>.
+            </li>
+              <li>In the <b>Java</b> &gt; <b>Compiler</b> &gt; <b>Building</b> preferences,
+                open the <b>Build Path Problems</b> section
+                and change <b>Circular Dependencies</b> from
+                <b>Error</b> to <b>Warning</b>.
+            
+            </li>
+            </ol></li>
+          <li>Change the PDE settings:
+            <ol>
+              <li>In the <b>Plug-in Development</b> &gt; <b>Compilers</b> preferences
+              change <b>Unresolved Dependencies</b> from
+                <b>Error</b> to <b>Warning</b>.
+            </li>
+              <li>In the <b>Plug-in Development</b> &gt; <b>Target Platform</b>
+                preferences, change the <b>Location</b> box to be the
+                <code>jre/lib/boot</code> directory of the classlib snapshot.</li>
+            </ol></li>
+        </ul>
+      <li>Copy the <code>ecj_3.2.jar</code> file into the 
+      <code>...\eclipse\plugins\org.apache.ant_1.6.5\lib</code> directory.</li>
+      <li>To include the given file, configure the following Ant settings in 
+      <b>Window</b> &gt; <b>Preferences</b> &gt; <b>Ant</b> &gt; <b>Runtime</b>:
+    </li>
+      <ul>
+        <li>Select <b>Global Entries</b>
+      </li>
+        <li>Select <b>Add External Jars</b>
+    </li>
+        <li>Add the <code>ecj_3.2.jar</code> file from
+          the <code>org.apache.ant_1.6.5\lib</code> directory.
+        </li>
+        </ul>
+    </ol>
+  
+  
+</subsection>
+
+<subsection name="Developing and Testing 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
+        <code>trunk &gt; modules</code>. Select
+        <code>nio</code> and from the context menu select
+        <b>Checkout...</b>, and on the checkout dialog box click <b>Finish</b>.</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
+            <code>JUNIT JAR</code> 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="Class Library Development: Step-by-Step Guide">
+<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 -Dpde.allowCycles=true</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: harmony/standard/site/xdocs/documentation/dev_eclipse.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: harmony/standard/site/xdocs/documentation/dev_eclipse_movie.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/xdocs/documentation/dev_eclipse_movie.html?rev=574189&r1=574188&r2=574189&view=diff
==============================================================================
--- harmony/standard/site/xdocs/documentation/dev_eclipse_movie.html (original)
+++ harmony/standard/site/xdocs/documentation/dev_eclipse_movie.html Mon Sep 10 02:33:37 2007
@@ -1,69 +1,69 @@
-<!--
-
-    Licensed to the Apache Software Foundation (ASF) under one or more
-    contributor license agreements.  See the NOTICE file distributed with
-    this work for additional information regarding copyright ownership.
-    The ASF licenses this file to You 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://harmony.apache.org/"><img  src="../../images/harmony-logo.png" alt="Apache Harmony" border="0"/></a>
-</td>
-</td>
-                    </td></tr></table>
-                    </td>
-                    <td align='RIGHT'>
-                    </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>
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You 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://harmony.apache.org/"><img  src="../../images/harmony-logo.png" alt="Apache Harmony" border="0"/></a>
+</td>
+</td>
+                    </td></tr></table>
+                    </td>
+                    <td align='RIGHT'>
+                    </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: harmony/standard/site/xdocs/documentation/dev_eclipse_movie.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: harmony/standard/site/xdocs/hdk.xml
URL: http://svn.apache.org/viewvc/harmony/standard/site/xdocs/hdk.xml?rev=574189&r1=574188&r2=574189&view=diff
==============================================================================
--- harmony/standard/site/xdocs/hdk.xml (original)
+++ harmony/standard/site/xdocs/hdk.xml Mon Sep 10 02:33:37 2007
@@ -1,147 +1,147 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-    Licensed to the Apache Software Foundation (ASF) under one or more
-    contributor license agreements. See the NOTICE file distributed with
-    this work for additional information regarding copyright ownership.
-    The ASF licenses this file to You 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>Harmony Development Kit for the Apache Harmony Class Library</title>
-        <author email="dev@harmony.apache.org">Harmony Documentation Team</author>
-    </properties>
-
-    <body>
-
-        <section name="Harmony Development Kit for the Apache Harmony Class Library">
-            <p>
-                The Harmony Development Kit (HDK) allows a Harmony developer to
-                rebuild any module of the Harmony Classlib in a standalone way by providing all the
-                necesary supplementary binaries and header files. This document describes the layout
-                of such an HDK and its contents.
-            </p>
-
-            <subsection name="Layout of the HDK">
-                <p>
-                    An HDK contains all the header files and binaries, both native and Java, required
-                    for a Harmony classlib developer to build against. The directory structure for an
-                    HDK is as follows:
-<pre>&lt;hdkbase&gt;
-    |
-    |---build
-    |     |---make
-    |     |---patternsets
-    |     \---test
-    |
-    |---jdk
-    |    |---jre
-    |    \---include
-    |
-    |---include
-    |
-    \---lib</pre>
-
-                    The directories laid out above are used in the following manner:
-
-                    <ul>
-                        <li>
-                            <code>&lt;hdkbase&gt;/build/make</code> - this directory contains include
-                            files used by native makefiles.
-                        </li>
-
-                        <li>
-                            <code>&lt;hdkbase&gt;/build/patternsets</code> - this directory contains
-                            patternsets describing jar content.
-                        </li>
-
-                        <li>
-                            <code>&lt;hdkbase&gt;/build/test</code> - this directory contains test
-                            support classes, bundled up into a jar file.
-                        </li>
-
-                        <li>
-                            <code>&lt;hdkbase&gt;/jdk/jre</code> - this directory contains the standard
-                            jre layout, including <code>bin</code> and <code>lib</code> directories.
-                        </li>
-
-                        <li>
-                            <code>&lt;hdkbase&gt;/jdk/include</code> - this directory contains the standard
-                            jdk header files. For example, jni.h is held here.
-                        </li>
-
-                        <li>
-                            <code>&lt;hdkbase&gt;/include</code> - this directory contains header files that
-                            are Harmony specific and are used across multiple classlib modules.
-                        </li>
-
-                        <li>
-                            <code>&lt;hdkbase&gt;/lib</code> - this directory is used in HDKs on Windows for
-                            .lib files and on Linux for .a files necessary for linking during compilation of
-                            classlib natives.
-                        </li>
-                    </ul>
-                </p>
-            </subsection>
-            <subsection name="Building Classlib Against an HDK">
-                <p class="note">Note</p>
-                <p class="notetext">The HDK and relevant build system changes are work in progress.
-                        Not all of the Ant targets/properties described exist yet, and thus not
-                        all of what is described below currently works. This disclaimer will be
-                        removed once work on the HDK is completed.</p>
-                    <p>
-                    The Harmony Class Library can be built at the global or modular level.
-                    At the modular level, there are three ways to build:</p>
-                    <ul>
-                        <li>
-                            <b>Building the default target</b> - An HDK is not required here, and the class
-                            library is built against and into the default (deploy) directory. This is the
-                            standard way to build, and is what happens when you just run <code>ant</code> at the
-                            command line.
-                        </li>
-                        <li>
-                            <b>Building against an HDK</b> - The location of an HDK must be specified at
-                            the Ant command line, and the ouptut will be built into the default (deploy)
-                            directory. The command line for this is <code><nobr>ant -DHY.HDK=path/to/HDK</nobr></code>.
-                        </li>
-                        <li>
-                            <b>Building against an HDK and into a target directory</b> - The location of
-                            an HDK and of a target directory must be specified on the Ant command line.
-                            The Class Library code will be compiled against the libraries contained in
-                            the HDK, and the output of those compiles will be placed into the specified
-                            target directory. The command line for this is <code><nobr>ant -DHY.HDK=path/to/HDK
-                            -DHY.TARGET=path/to/target</nobr>
-                            </code>.
-                        </li>
-                    </ul>
-                    <p class="example">Example</p>
-                    <p class="exampletext">
-                   If you wanted to build only the luni module against
-                    an HDK, and put the resulting artifacts into a separate target directory,
-                    do the following:
-                    <ol>
-                        <li>Checkout the luni module</li>
-                        <li>cd into the root directory of the module</li>
-                        <li>Execute <code>
-                            <nobr>ant -DHY.HDK=path/to/hdk -DHY.TARGET=path/to/target</nobr>
-                        </code></li>
-                    </ol></p>
-                    <p>The luni Java and native code will be built against the HDK location
-                    specified, and all produced binaries placed under the target directory, laid
-                    out in the HDK structure described at the top of this page.
-                </p>
-            </subsection>
-        </section>
-    </body>
-</document>
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements. See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You 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>Harmony Development Kit for the Apache Harmony Class Library</title>
+        <author email="dev@harmony.apache.org">Harmony Documentation Team</author>
+    </properties>
+
+    <body>
+
+        <section name="Harmony Development Kit for the Apache Harmony Class Library">
+            <p>
+                The Harmony Development Kit (HDK) allows a Harmony developer to
+                rebuild any module of the Harmony Classlib in a standalone way by providing all the
+                necesary supplementary binaries and header files. This document describes the layout
+                of such an HDK and its contents.
+            </p>
+
+            <subsection name="Layout of the HDK">
+                <p>
+                    An HDK contains all the header files and binaries, both native and Java, required
+                    for a Harmony classlib developer to build against. The directory structure for an
+                    HDK is as follows:
+<pre>&lt;hdkbase&gt;
+    |
+    |---build
+    |     |---make
+    |     |---patternsets
+    |     \---test
+    |
+    |---jdk
+    |    |---jre
+    |    \---include
+    |
+    |---include
+    |
+    \---lib</pre>
+
+                    The directories laid out above are used in the following manner:
+
+                    <ul>
+                        <li>
+                            <code>&lt;hdkbase&gt;/build/make</code> - this directory contains include
+                            files used by native makefiles.
+                        </li>
+
+                        <li>
+                            <code>&lt;hdkbase&gt;/build/patternsets</code> - this directory contains
+                            patternsets describing jar content.
+                        </li>
+
+                        <li>
+                            <code>&lt;hdkbase&gt;/build/test</code> - this directory contains test
+                            support classes, bundled up into a jar file.
+                        </li>
+
+                        <li>
+                            <code>&lt;hdkbase&gt;/jdk/jre</code> - this directory contains the standard
+                            jre layout, including <code>bin</code> and <code>lib</code> directories.
+                        </li>
+
+                        <li>
+                            <code>&lt;hdkbase&gt;/jdk/include</code> - this directory contains the standard
+                            jdk header files. For example, jni.h is held here.
+                        </li>
+
+                        <li>
+                            <code>&lt;hdkbase&gt;/include</code> - this directory contains header files that
+                            are Harmony specific and are used across multiple classlib modules.
+                        </li>
+
+                        <li>
+                            <code>&lt;hdkbase&gt;/lib</code> - this directory is used in HDKs on Windows for
+                            .lib files and on Linux for .a files necessary for linking during compilation of
+                            classlib natives.
+                        </li>
+                    </ul>
+                </p>
+            </subsection>
+            <subsection name="Building Classlib Against an HDK">
+                <p class="note">Note</p>
+                <p class="notetext">The HDK and relevant build system changes are work in progress.
+                        Not all of the Ant targets/properties described exist yet, and thus not
+                        all of what is described below currently works. This disclaimer will be
+                        removed once work on the HDK is completed.</p>
+                    <p>
+                    The Harmony Class Library can be built at the global or modular level.
+                    At the modular level, there are three ways to build:</p>
+                    <ul>
+                        <li>
+                            <b>Building the default target</b> - An HDK is not required here, and the class
+                            library is built against and into the default (deploy) directory. This is the
+                            standard way to build, and is what happens when you just run <code>ant</code> at the
+                            command line.
+                        </li>
+                        <li>
+                            <b>Building against an HDK</b> - The location of an HDK must be specified at
+                            the Ant command line, and the ouptut will be built into the default (deploy)
+                            directory. The command line for this is <code><nobr>ant -DHY.HDK=path/to/HDK</nobr></code>.
+                        </li>
+                        <li>
+                            <b>Building against an HDK and into a target directory</b> - The location of
+                            an HDK and of a target directory must be specified on the Ant command line.
+                            The Class Library code will be compiled against the libraries contained in
+                            the HDK, and the output of those compiles will be placed into the specified
+                            target directory. The command line for this is <code><nobr>ant -DHY.HDK=path/to/HDK
+                            -DHY.TARGET=path/to/target</nobr>
+                            </code>.
+                        </li>
+                    </ul>
+                    <p class="example">Example</p>
+                    <p class="exampletext">
+                   If you wanted to build only the luni module against
+                    an HDK, and put the resulting artifacts into a separate target directory,
+                    do the following:
+                    <ol>
+                        <li>Checkout the luni module</li>
+                        <li>cd into the root directory of the module</li>
+                        <li>Execute <code>
+                            <nobr>ant -DHY.HDK=path/to/hdk -DHY.TARGET=path/to/target</nobr>
+                        </code></li>
+                    </ol></p>
+                    <p>The luni Java and native code will be built against the HDK location
+                    specified, and all produced binaries placed under the target directory, laid
+                    out in the HDK structure described at the top of this page.
+                </p>
+            </subsection>
+        </section>
+    </body>
+</document>

Propchange: harmony/standard/site/xdocs/hdk.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: harmony/standard/site/xdocs/issue_resolution_guideline.xml
URL: http://svn.apache.org/viewvc/harmony/standard/site/xdocs/issue_resolution_guideline.xml?rev=574189&r1=574188&r2=574189&view=diff
==============================================================================
--- harmony/standard/site/xdocs/issue_resolution_guideline.xml (original)
+++ harmony/standard/site/xdocs/issue_resolution_guideline.xml Mon Sep 10 02:33:37 2007
@@ -1,118 +1,118 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!--
-    Licensed to the Apache Software Foundation (ASF) under one or more
-    contributor license agreements. See the NOTICE file distributed with
-    this work for additional information regarding copyright ownership.
-    The ASF licenses this file to You 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>Good Issue Resolution Guideline</title>
-    <author email="dev@harmony.apache.org">Harmony Documentation Team</author>
-</properties>
-
-<body>
-
-    <section name="Good Issue Resolution Guideline">
-    <p>
-      This guideline provides step-by-step instructions on reporting, resolving 
-      and closing issues. If you cannot do one of the steps, then write a comment to the issue.
-    </p>
-       
-    <subsection name="Reporting Issues">
-    
-    <ol>
-        <li>State the expected behavior and the
-            actual behavior of Harmony code explicitly. Use links to 
-            specifications, references, etc.</li>
-        <li>Create a test case as small as possible. A patch
-            to test is highly appreciated.</li>
-        <li>Provide maximum information about steps necessary to reproduce the bug.
-            If a patch for the test has not been supplied, provide as much
-            diagnostic information about the failure as possible: stack trace,
-            failure output, expected output, etc.</li>
-        <li>Use issue links if applicable.</li>
-        <li>Check the issue resolution, when it is committed. Add a comment.</li>
-    </ol>
-   
-    </subsection>
-
-    <subsection name="Resolving Issues">
-      <p>To resolve an issue, define its type first.</p>
-    <dl>
-        <dt>If the issue is a non-bug difference, not a bug or invalid,
-            you should do the following:</dt>
-            <dd><ol>
-                <li>Discuss the issue on the 
-                <a href="mailing.html">developer mailing list</a>.</li>
-                <li>Add a link to the discussion thread as a comment to the issue.</li>
-            </ol>
-        </dd>
-        
-       <dt>If the issue is a bug, you should do the following:</dt>
-            <dd><ol>
-                <li>
-                  Notify the community that you started investigation by adding
-                  a comment to the issue and send a message to the 
-                  <a href="mailing.html">developer mailing list</a>.
-                  If you cannot create a patch, add another comment with your 
-                  investigation results.</li>
-                <li>If reporter did not provide a patch to test:
-                    <ul>
-                        <li>Try to create a patch to test.</li>
-                        <li>If you cannot create a patch, write a comment about it.</li>
-                    </ul>
-                </li>
-                <li>
-                  Create a patch to fix the issue. If you have any questions,
-                  discuss them on the <a href="mailing.html">developer mailing list</a>.
-                  Add a link to the discussion as a comment.</li>
-                <li>All pacthes, such as tests and fixes, should be relative to the directory where 
-                the main <code>build.xml</code> is:<br/>
-                <code>https://svn.apache.org/repos/asf/harmony/enhanced/classlib/trunk</code>,<br/>
-                or to the module root directory.</li>
-                <li>Test and fix patches should be in different files.</li>
-                <li>If the patch requires adding, removing or moving some files in the repository, 
-                provide the appropriate script.</li>
-                <li>Check that all unit tests pass.</li>
-                <li>If the issue is application-oriented, check the application.</li>
-                <li>Use issue links if applicable.</li>
-            </ol>
-      </dd></dl>
-    </subsection>
-
-    <subsection name="Closing Issues">
-      <p>To close an issue, define its type first.</p>
-    <dl>
-        <dt>If the issue is a non-bug difference, not a bug or invalid, you should do the following:</dt>
-        <dd> Close the issue.</dd>
-            <dt>If the issue is a bug, you should do the following: </dt>
-              <dd>  <ol>
-                    <li>If a patch to test is available, apply it.</li>
-                    <li>Check that the test fails.</li>
-                    <li>Apply the fix for the issue.</li>
-                    <li>Check that test succeeds now.</li>
-                    <li>Make sure that all unit tests pass.</li>
-                    <li>For application-oriented issues, check the application.</li>
-                    <li>If there are any problems on previous steps, post a comment to
-                    JIRA and let "resolution provider" resolve them.</li>
-                    <li>Make sure that the issue reporter is happy with the resolution.</li>
-                    <li>Add revision info into the JIRA issue.</li>
-                </ol>
-         </dd></dl>
-    </subsection>
-  </section>
-</body>
-</document>
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements. See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You 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>Good Issue Resolution Guideline</title>
+    <author email="dev@harmony.apache.org">Harmony Documentation Team</author>
+</properties>
+
+<body>
+
+    <section name="Good Issue Resolution Guideline">
+    <p>
+      This guideline provides step-by-step instructions on reporting, resolving 
+      and closing issues. If you cannot do one of the steps, then write a comment to the issue.
+    </p>
+       
+    <subsection name="Reporting Issues">
+    
+    <ol>
+        <li>State the expected behavior and the
+            actual behavior of Harmony code explicitly. Use links to 
+            specifications, references, etc.</li>
+        <li>Create a test case as small as possible. A patch
+            to test is highly appreciated.</li>
+        <li>Provide maximum information about steps necessary to reproduce the bug.
+            If a patch for the test has not been supplied, provide as much
+            diagnostic information about the failure as possible: stack trace,
+            failure output, expected output, etc.</li>
+        <li>Use issue links if applicable.</li>
+        <li>Check the issue resolution, when it is committed. Add a comment.</li>
+    </ol>
+   
+    </subsection>
+
+    <subsection name="Resolving Issues">
+      <p>To resolve an issue, define its type first.</p>
+    <dl>
+        <dt>If the issue is a non-bug difference, not a bug or invalid,
+            you should do the following:</dt>
+            <dd><ol>
+                <li>Discuss the issue on the 
+                <a href="mailing.html">developer mailing list</a>.</li>
+                <li>Add a link to the discussion thread as a comment to the issue.</li>
+            </ol>
+        </dd>
+        
+       <dt>If the issue is a bug, you should do the following:</dt>
+            <dd><ol>
+                <li>
+                  Notify the community that you started investigation by adding
+                  a comment to the issue and send a message to the 
+                  <a href="mailing.html">developer mailing list</a>.
+                  If you cannot create a patch, add another comment with your 
+                  investigation results.</li>
+                <li>If reporter did not provide a patch to test:
+                    <ul>
+                        <li>Try to create a patch to test.</li>
+                        <li>If you cannot create a patch, write a comment about it.</li>
+                    </ul>
+                </li>
+                <li>
+                  Create a patch to fix the issue. If you have any questions,
+                  discuss them on the <a href="mailing.html">developer mailing list</a>.
+                  Add a link to the discussion as a comment.</li>
+                <li>All pacthes, such as tests and fixes, should be relative to the directory where 
+                the main <code>build.xml</code> is:<br/>
+                <code>https://svn.apache.org/repos/asf/harmony/enhanced/classlib/trunk</code>,<br/>
+                or to the module root directory.</li>
+                <li>Test and fix patches should be in different files.</li>
+                <li>If the patch requires adding, removing or moving some files in the repository, 
+                provide the appropriate script.</li>
+                <li>Check that all unit tests pass.</li>
+                <li>If the issue is application-oriented, check the application.</li>
+                <li>Use issue links if applicable.</li>
+            </ol>
+      </dd></dl>
+    </subsection>
+
+    <subsection name="Closing Issues">
+      <p>To close an issue, define its type first.</p>
+    <dl>
+        <dt>If the issue is a non-bug difference, not a bug or invalid, you should do the following:</dt>
+        <dd> Close the issue.</dd>
+            <dt>If the issue is a bug, you should do the following: </dt>
+              <dd>  <ol>
+                    <li>If a patch to test is available, apply it.</li>
+                    <li>Check that the test fails.</li>
+                    <li>Apply the fix for the issue.</li>
+                    <li>Check that test succeeds now.</li>
+                    <li>Make sure that all unit tests pass.</li>
+                    <li>For application-oriented issues, check the application.</li>
+                    <li>If there are any problems on previous steps, post a comment to
+                    JIRA and let "resolution provider" resolve them.</li>
+                    <li>Make sure that the issue reporter is happy with the resolution.</li>
+                    <li>Add revision info into the JIRA issue.</li>
+                </ol>
+         </dd></dl>
+    </subsection>
+  </section>
+</body>
+</document>

Propchange: harmony/standard/site/xdocs/issue_resolution_guideline.xml
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message