You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by te...@apache.org on 2006/02/13 13:04:36 UTC
svn commit: r377360 - in /incubator/harmony/standard/site:
docs/subcomponents/classlibrary/index.html
docs/subcomponents/classlibrary/pkgnaming.html
xdocs/subcomponents/classlibrary/index.xml
xdocs/subcomponents/classlibrary/pkgnaming.xml
Author: tellison
Date: Mon Feb 13 04:04:34 2006
New Revision: 377360
URL: http://svn.apache.org/viewcvs?rev=377360&view=rev
Log:
Added links ot existing doc in SVN, and proposed pkg naming guidelines.
Added:
incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html
incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml
Modified:
incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html
incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml
Modified: incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html?rev=377360&r1=377359&r2=377360&view=diff
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html (original)
+++ incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html Mon Feb 13 04:04:34 2006
@@ -203,20 +203,80 @@
<p>
The following documentation links are specific to the class library effort underway at Apache Harmony.
</p>
- <ul>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Developing and Building the code"><strong>Developing and Building the code</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <ul>
<li><a href="build_classlib.html">Building the Classlibrary Code</a>
<p>
Describes how to download and build the class library code from source.
</p>
</li>
- <br />
<li><a href="dev_eclipse.html">Development with the Eclipse IDE</a>
<p>
Describes how to set up Eclipse to develop the class library code.
</p>
</li>
- <br />
</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="Project conventions"><strong>Project conventions</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <ul>
+ <li><a href="pkgnaming.html">Java package naming guidelines</a>
+ <p>
+ <b>Proposed</b> guidelines for package naming convention.
+ </p>
+ </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="Architecture and guides"><strong>Architecture and guides</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <ul>
+ <li>
+<a href="http://svn.apache.org/viewcvs.cgi/*checkout*/incubator/harmony/enhanced/classlib/trunk/doc/vm_doc/html/index.html">
+ Class library porting documentation</a>
+ <p>
+ A porting guide aimed at developers interested in porting the classlib
+ code to a new VM.
+ </p></li>
+ <li>
+<a href="http://svn.apache.org/viewcvs.cgi/*checkout*/incubator/harmony/enhanced/classlib/trunk/doc/vm_doc/html/group__Port.html">
+ The Harmony class library port layer</a>
+ <p>
+ A description of the functions in the class library portlayer aimed at
+ developers who are writing JNI code for use by the Harmony class libraries
+ and developers who are interested in porting the classlib code to a new
+ operating system.
+ </p>
+ </li>
+ </ul>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
</blockquote>
</p>
</td></tr>
Added: incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html?rev=377360&view=auto
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html (added)
+++ incubator/harmony/standard/site/docs/subcomponents/classlibrary/pkgnaming.html Mon Feb 13 04:04:34 2006
@@ -0,0 +1,343 @@
+<!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 - Package naming conventions in the Apache Harmony Classlib</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="Package naming conventions used in the Apache Harmony Class Library"><strong>Package naming conventions used in the Apache Harmony Class Library</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ <small><em>This section is inspired by, and derived from,
+ <a href="http://dev.eclipse.org/naming.html">the Eclipse package naming convention</a>
+ documentation.</em></small>
+ </p>
+ <p>
+ <big><em>The following guidelines are currently PROPOSED and being discussed on the
+ development mailing list <code>harmony-dev@incubator.apache.org</code>. Please
+ direct comments and questions there.</em></big>
+ </p>
+ <p>
+ The Harmony class library code is organized into Java packages comprising the
+ public API (packages such as <code>java.lang</code>, <code>org.omg.CORBA</code>
+ and so on) and internal implementation packages that all begin
+ <code>org.apache.harmony</code>.
+ </p>
+ <p>
+ The public APIs are defined by the JSE specification, and as such as managed beyond
+ the direct control of the Apache Harmony project. The other packages are managed
+ by the project development team, and as such the project attributes the following
+ meaning to package names.
+ </p>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="All packages belong to a specific module"><strong>All packages belong to a specific module</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <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><module></b></code>
+ </blockquote>
+ for example
+ <blockquote>
+ <code>org.apache.harmony.luni</code><br />
+ <code>org.apache.harmony.security</code>
+ </blockquote>
+ </p>
+ </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="Package names within a module"><strong>Package names within a module</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ Modules are free to use whatever package names they choose with the
+ prefix <code>org.apache.harmony.<b><modulename></b></code>
+ </p>
+ <p>
+ The following package name segements are <ul>reserved</ul> to indicate the meanings
+ defined below:
+ <ul>
+ <li><code>org.apache.harmony.<modulename>.<b>internal</b></code>
+ <p>
+ Packages with this prefix are implementation packages for use within
+ the given module. Types and fields that are visible within these
+ packages <em>MUST NOT</em> be used outside the module itself.
+ Some runtime environments may enforce this reduced visibility scope.
+ </p></li>
+ <li><code>org.apache.harmony.<modulename>.<b>tests</b></code>
+ <p>
+ Packages with this prefix contain test code that is not part of the
+ module API or implementation. Some builds may not include these
+ packages.
+ </p></li>
+ <li><code>org.apache.harmony.<modulename>.<b>examples</b></code>
+ <p>
+ Packages with this prefix contain example code that is not part of the
+ module API or implementation. Some builds may not include these
+ packages.
+ </p></li>
+ <li><code>org.apache.harmony.<modulename>.<b><anything_else></b></code>
+ <p>
+ All other packages within a module contain internal APIs that may
+ be referenced from any module.
+ </p></li>
+ </ul>
+ </p>
+ <p>
+ In practice, this means that module developers are free to change the code within an
+ <code>internal</code> package without expecting any consequences beyond the module
+ itself. However, module developers who modify code that is not in an
+ <code>internal</code> package must do so in a manner that ensures
+ <a href="http://java.sun.com/docs/books/jls/second_edition/html/binaryComp.doc.html">
+ Java binary compatibility</a>
+ </p>
+ </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 -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml?rev=377360&r1=377359&r2=377360&view=diff
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml Mon Feb 13 04:04:34 2006
@@ -31,20 +31,53 @@
The following documentation links are specific to the class library effort underway at Apache Harmony.
</p>
+<subsection name="Developing and Building the code">
<ul>
<li><a href="build_classlib.html">Building the Classlibrary Code</a>
<p>
Describes how to download and build the class library code from source.
</p>
</li>
- <br/>
<li><a href="dev_eclipse.html">Development with the Eclipse IDE</a>
<p>
Describes how to set up Eclipse to develop the class library code.
</p>
</li>
- <br/>
</ul>
+</subsection>
+
+<subsection name="Project conventions">
+ <ul>
+ <li><a href="pkgnaming.html">Java package naming guidelines</a>
+ <p>
+ <b>Proposed</b> guidelines for package naming convention.
+ </p>
+ </li>
+ </ul>
+</subsection>
+
+<subsection name="Architecture and guides">
+ <ul>
+ <li>
+<a href="http://svn.apache.org/viewcvs.cgi/*checkout*/incubator/harmony/enhanced/classlib/trunk/doc/vm_doc/html/index.html">
+ Class library porting documentation</a>
+ <p>
+ A porting guide aimed at developers interested in porting the classlib
+ code to a new VM.
+ </p></li>
+ <li>
+<a href="http://svn.apache.org/viewcvs.cgi/*checkout*/incubator/harmony/enhanced/classlib/trunk/doc/vm_doc/html/group__Port.html">
+ The Harmony class library port layer</a>
+ <p>
+ A description of the functions in the class library portlayer aimed at
+ developers who are writing JNI code for use by the Harmony class libraries
+ and developers who are interested in porting the classlib code to a new
+ operating system.
+ </p>
+ </li>
+ </ul>
+</subsection>
+
</section>
</body>
Added: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml?rev=377360&view=auto
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml (added)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/pkgnaming.xml Mon Feb 13 04:04:34 2006
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+ Copyright 2006 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<document>
+
+ <properties>
+ <title>Package naming conventions in the Apache Harmony Classlib</title>
+ <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+<body>
+
+<section name="Package naming conventions used in the Apache Harmony Class Library">
+ <p>
+ <small><em>This section is inspired by, and derived from,
+ <a href="http://dev.eclipse.org/naming.html">the Eclipse package naming convention</a>
+ documentation.</em></small>
+ </p>
+ <p>
+ <big><em>The following guidelines are currently PROPOSED and being discussed on the
+ development mailing list <code>harmony-dev@incubator.apache.org</code>. Please
+ direct comments and questions there.</em></big>
+ </p>
+ <p>
+ The Harmony class library code is organized into Java packages comprising the
+ public API (packages such as <code>java.lang</code>, <code>org.omg.CORBA</code>
+ and so on) and internal implementation packages that all begin
+ <code>org.apache.harmony</code>.
+ </p>
+ <p>
+ The public APIs are defined by the JSE specification, and as such as managed beyond
+ the direct control of the Apache Harmony project. The other packages are managed
+ by the project development team, and as such the project attributes the following
+ meaning to package names.
+ </p>
+
+<subsection name="All packages belong to a specific module">
+ <p>
+ Each Java package is owned by a specific module of the Harmony class library.
+ The module name immediately follows the <code>org.apache.harmony</code> prefix.
+ <blockquote>
+ <code>org.apache.harmony.<b><module></b></code>
+ </blockquote>
+ for example
+ <blockquote>
+ <code>org.apache.harmony.luni</code><br/>
+ <code>org.apache.harmony.security</code>
+ </blockquote>
+ </p>
+</subsection>
+
+<subsection name="Package names within a module">
+ <p>
+ Modules are free to use whatever package names they choose with the
+ prefix <code>org.apache.harmony.<b><modulename></b></code>
+ </p>
+ <p>
+ The following package name segements are <ul>reserved</ul> to indicate the meanings
+ defined below:
+ <ul>
+ <li><code>org.apache.harmony.<modulename>.<b>internal</b></code>
+ <p>
+ Packages with this prefix are implementation packages for use within
+ the given module. Types and fields that are visible within these
+ packages <em>MUST NOT</em> be used outside the module itself.
+ Some runtime environments may enforce this reduced visibility scope.
+ </p></li>
+ <li><code>org.apache.harmony.<modulename>.<b>tests</b></code>
+ <p>
+ Packages with this prefix contain test code that is not part of the
+ module API or implementation. Some builds may not include these
+ packages.
+ </p></li>
+ <li><code>org.apache.harmony.<modulename>.<b>examples</b></code>
+ <p>
+ Packages with this prefix contain example code that is not part of the
+ module API or implementation. Some builds may not include these
+ packages.
+ </p></li>
+ <li><code>org.apache.harmony.<modulename>.<b><anything_else></b></code>
+ <p>
+ All other packages within a module contain internal APIs that may
+ be referenced from any module.
+ </p></li>
+ </ul>
+ </p>
+ <p>
+ In practice, this means that module developers are free to change the code within an
+ <code>internal</code> package without expecting any consequences beyond the module
+ itself. However, module developers who modify code that is not in an
+ <code>internal</code> package must do so in a manner that ensures
+ <a href="http://java.sun.com/docs/books/jls/second_edition/html/binaryComp.doc.html">
+ Java binary compatibility</a>
+ </p>
+</subsection>
+</section>
+</body>
+</document>
\ No newline at end of file