You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by sm...@apache.org on 2006/05/24 11:30:15 UTC
svn commit: r409098 - in /incubator/harmony/standard/site:
docs/subcomponents/classlibrary/agreements.html
docs/subcomponents/classlibrary/index.html
xdocs/subcomponents/classlibrary/agreements.xml
xdocs/subcomponents/classlibrary/index.xml
Author: smishura
Date: Wed May 24 02:30:14 2006
New Revision: 409098
URL: http://svn.apache.org/viewvc?rev=409098&view=rev
Log:
Adding summary for harmony-dev mailing list
Added:
incubator/harmony/standard/site/docs/subcomponents/classlibrary/agreements.html (with props)
incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/agreements.xml (with props)
Modified:
incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html
incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml
Added: incubator/harmony/standard/site/docs/subcomponents/classlibrary/agreements.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/subcomponents/classlibrary/agreements.html?rev=409098&view=auto
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/classlibrary/agreements.html (added)
+++ incubator/harmony/standard/site/docs/subcomponents/classlibrary/agreements.html Wed May 24 02:30:14 2006
@@ -0,0 +1,367 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Copyright 1999-2004 The Apache Software Foundation
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="Harmony Documentation Team">
+ <meta name="email" value="harmony-dev@incubator.apache.org">
+
+
+
+
+
+
+
+ <title>Apache Harmony - Harmony-dev agreements and recommendations</title>
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <table><tr><td>
+ <td align="left">
+<a href="http://incubator.apache.org/harmony/"><img src="../../images/harmony-logo.png" alt="Apache Harmony" border="0"/></a>
+</td>
+</td>
+ </td></tr></table>
+ </td>
+ <td align='RIGHT'>
+ <a href="http://incubator.apache.org/harmony/">
+ <img src="http://incubator.apache.org/harmony/images/apache-incubator-logo.png"
+ alt="Apache Harmony" border="0"/></a>
+ </td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://apachecon.com/2005/US/">
+ <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+ width="125" border="0" alt="ApacheCon US 2005" />
+ </a>
+ -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p><strong>General</strong></p>
+ <ul>
+ <li> <a href="../../index.html">Home</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../license.html">License</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../contribution_policy.html">Contribution Policy</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../guidelines.html">Project Guidelines</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="http://www.apache.org/">ASF</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../downloads.html">Downloads</a>
+</li>
+
+ <table>
+ </table>
+ </ul>
+ <p><strong>Community</strong></p>
+ <ul>
+ <li> <a href="../../get-involved.html">Get Involved</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../contributors.html">Committers</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../mailing.html">Mailing Lists</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../documentation/documentation.html">Documentation</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../faq.html">FAQ</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="http://wiki.apache.org/harmony">Wiki</a>
+</li>
+
+ <table>
+ </table>
+ </ul>
+ <p><strong>Development</strong></p>
+ <ul>
+ <li> <a href="../../status.html">How Are We Doing?</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../roadmap.html">Road Map / TODO</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../svn.html">Source Code</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="http://issues.apache.org/jira/browse/HARMONY">JIRA</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../related.html">Other Projects</a>
+</li>
+
+ <table>
+ </table>
+ </ul>
+ <p><strong>Subcomponents</strong></p>
+ <ul>
+ <li> <a href="../../subcomponents/classlibrary/index.html">Class Library</a>
+</li>
+
+ <table>
+ <tr><td>
+ <a href="../../subcomponents/classlibrary/status.html">Status</a>
+ </td></tr>
+ </table>
+ <li> <a href="../../subcomponents/jchevm/index.html">Virtual Machine JCHEVM</a>
+</li>
+
+ <table>
+ </table>
+ </ul>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Harmony-dev agreements and recommendations"><strong>Harmony-dev agreements and recommendations</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ <big><em>The summary of agreements and recommendations that were
+ discussed on the development mailing list <code>harmony-dev@incubator.apache.org</code>.
+ Please feel free to sent your comments and questions there.</em></big>
+ </p>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Development"><strong>Development</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <ul>
+ <li>serialVersionUID MUST be explicitly specified for each Serializable class to provide compatibility
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c906dd82e0601190059x3162c6c6u533928579c226572@mail.gmail.com%3e">
+ [classlib] serialVersionUIDs for Serializable classes</a>)
+ </li>
+
+ <li>Exception messages MUST be internationalized
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200604.mbox/%3c44478DC3.4070206@gmail.com%3e">
+ Internationalized messages</a>)
+ </li>
+
+ <li>A golden ticket MUST be acquired to update java.lang.String class
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200604.mbox/%3c444788A0.6000102@gmail.com%3e">
+ [classlib] String is special</a>)
+ </li>
+
+ <li>Mark deprecated stuff with @deprecated keyword
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c4405BE70.1020307@gmail.com%3e">
+ deprecated methods , javadocs</a>)
+ </li>
+
+ <li>Error messages should contain helpfull information
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3cfcb9f9160603240835i792de7dobabfc43a44e7c752@mail.gmail.com%3e">
+ More helpful error messages</a>)
+ </li>
+
+ <li>We clarify/add our specific to javadoc, provide examples. Also it should contain a reference to Sun's javadoc
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c43C38BCC.6070308@gmail.com%3e">
+ Writing JavaDoc</a>)
+ </li>
+ </ul>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Testing"><strong>Testing</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <ul>
+ <li>Follow <a href="http://www.javaworld.com/javaworld/jw-12-2000/jw-1221-junit_p.html">guidelines</a> for unit tests
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c442B7857.7040002@gmail.com%3e">
+ [Testing Convention] Keep tests small and fast</a>)
+ </li>
+
+ <li>There is no separate regression testsuite. Regression tests are added to unit tests with comments pointing out to JIRA bug.
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200512.mbox/%3ce3b630230512300651t574d876ex5de59ad667697acb@mail.gmail.com%3e">
+ regression test suite</a>)
+ </li>
+
+ <li>Create separate test suites for exotic configurations
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c906dd82e0601260338i61bc439fr708c664181dc8f20@mail.gmail.com%3e">
+ [testing] code for exotic configurations</a>)
+ </li>
+
+ <li>No logging for unit tests
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c906dd82e0601232340n5de6f561v8bb6db7ac4756f1c@mail.gmail.com%3e">
+ [classlib] Unit and performance testing</a>)
+ </li>
+
+ <li>All resource files are located in <module root>/src/test/resources folder and added to classpath
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c44126B5C.1020104@gmail.com%3e">
+ Location of test data files</a>)
+ </li>
+ </ul>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Others"><strong>Others</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <ul>
+ <li>Separate module for providers should be created
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c6e47b64f0601170332k3d418fabwd25a264c5e0f1532@mail.gmail.com%3e">
+ componentization: more modules might be necessary</a>)
+ </li>
+
+ <li>JIRA issue can be reassigned if it is not marked as 'In Progress'
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c43D76E6A.90509@gmail.com%3e">
+ Stealing JIRA issues</a>)
+ </li>
+
+ <li>New files should be created with svn property eol-style=native
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c442AF8CD.6040004@gmail.com%3e">
+ EOL differences in svn diffs</a>)
+ </li>
+
+ <li>Mail threads should have subject with prefix
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200604.mbox/%3c443133C5.3010602@pobox.com%3e">
+ [admin] prefixes?</a>)
+ </li>
+
+ <li>Create component status pages and keep them up to date
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c440D8F7B.3080902@googlemail.com%3e">
+ Component status pages</a>)
+ </li>
+ </ul>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div align="center"><font color="#525D76" size="-1"><em>
+ Copyright © 2003-2006, The Apache Software Foundation
+ </em></font></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Propchange: incubator/harmony/standard/site/docs/subcomponents/classlibrary/agreements.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html?rev=409098&r1=409097&r2=409098&view=diff
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html (original)
+++ incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html Wed May 24 02:30:14 2006
@@ -270,6 +270,12 @@
naming conventions for resource files.
</p>
</li>
+
+ <li><a href="agreements.html">Harmony-dev agreements</a>
+ <p>
+ Summary of agreements and recommendations worked out on harmony-dev mailing list.
+ </p>
+ </li>
</ul>
</blockquote>
</td></tr>
Added: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/agreements.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/agreements.xml?rev=409098&view=auto
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/agreements.xml (added)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/agreements.xml Wed May 24 02:30:14 2006
@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+ Copyright 2006 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<document>
+
+ <properties>
+ <title>Harmony-dev agreements and recommendations</title>
+ <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+<body>
+
+<section name="Harmony-dev agreements and recommendations">
+ <p>
+ <big><em>The summary of agreements and recommendations that were
+ discussed on the development mailing list <code>harmony-dev@incubator.apache.org</code>.
+ Please feel free to sent your comments and questions there.</em></big>
+ </p>
+
+<subsection name="Development">
+ <ul>
+ <li>serialVersionUID MUST be explicitly specified for each Serializable class to provide compatibility
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c906dd82e0601190059x3162c6c6u533928579c226572@mail.gmail.com%3e">
+ [classlib] serialVersionUIDs for Serializable classes</a>)
+ </li>
+
+ <li>Exception messages MUST be internationalized
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200604.mbox/%3c44478DC3.4070206@gmail.com%3e">
+ Internationalized messages</a>)
+ </li>
+
+ <li>A golden ticket MUST be acquired to update java.lang.String class
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200604.mbox/%3c444788A0.6000102@gmail.com%3e">
+ [classlib] String is special</a>)
+ </li>
+
+ <li>Mark deprecated stuff with @deprecated keyword
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c4405BE70.1020307@gmail.com%3e">
+ deprecated methods , javadocs</a>)
+ </li>
+
+ <li>Error messages should contain helpfull information
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3cfcb9f9160603240835i792de7dobabfc43a44e7c752@mail.gmail.com%3e">
+ More helpful error messages</a>)
+ </li>
+
+ <li>We clarify/add our specific to javadoc, provide examples. Also it should contain a reference to Sun's javadoc
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c43C38BCC.6070308@gmail.com%3e">
+ Writing JavaDoc</a>)
+ </li>
+ </ul>
+</subsection>
+
+<subsection name="Testing">
+ <ul>
+ <li>Follow <a href="http://www.javaworld.com/javaworld/jw-12-2000/jw-1221-junit_p.html">guidelines</a> for unit tests
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c442B7857.7040002@gmail.com%3e">
+ [Testing Convention] Keep tests small and fast</a>)
+ </li>
+
+ <li>There is no separate regression testsuite. Regression tests are added to unit tests with comments pointing out to JIRA bug.
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200512.mbox/%3ce3b630230512300651t574d876ex5de59ad667697acb@mail.gmail.com%3e">
+ regression test suite</a>)
+ </li>
+
+ <li>Create separate test suites for exotic configurations
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c906dd82e0601260338i61bc439fr708c664181dc8f20@mail.gmail.com%3e">
+ [testing] code for exotic configurations</a>)
+ </li>
+
+ <li>No logging for unit tests
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c906dd82e0601232340n5de6f561v8bb6db7ac4756f1c@mail.gmail.com%3e">
+ [classlib] Unit and performance testing</a>)
+ </li>
+
+ <li>All resource files are located in <module root>/src/test/resources folder and added to classpath
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c44126B5C.1020104@gmail.com%3e">
+ Location of test data files</a>)
+ </li>
+ </ul>
+</subsection>
+
+<subsection name="Others">
+ <ul>
+ <li>Separate module for providers should be created
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c6e47b64f0601170332k3d418fabwd25a264c5e0f1532@mail.gmail.com%3e">
+ componentization: more modules might be necessary</a>)
+ </li>
+
+ <li>JIRA issue can be reassigned if it is not marked as 'In Progress'
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200601.mbox/%3c43D76E6A.90509@gmail.com%3e">
+ Stealing JIRA issues</a>)
+ </li>
+
+ <li>New files should be created with svn property eol-style=native
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c442AF8CD.6040004@gmail.com%3e">
+ EOL differences in svn diffs</a>)
+ </li>
+
+ <li>Mail threads should have subject with prefix
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200604.mbox/%3c443133C5.3010602@pobox.com%3e">
+ [admin] prefixes?</a>)
+ </li>
+
+ <li>Create component status pages and keep them up to date
+ (<a href="http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200603.mbox/%3c440D8F7B.3080902@googlemail.com%3e">
+ Component status pages</a>)
+ </li>
+ </ul>
+</subsection>
+
+</section>
+</body>
+</document>
Propchange: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/agreements.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml?rev=409098&r1=409097&r2=409098&view=diff
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml Wed May 24 02:30:14 2006
@@ -82,6 +82,12 @@
naming conventions for resource files.
</p>
</li>
+
+ <li><a href="agreements.html">Harmony-dev agreements</a>
+ <p>
+ Summary of agreements and recommendations worked out on harmony-dev mailing list.
+ </p>
+ </li>
</ul>
</subsection>