Apache Harmony development using Eclipse

Reply-To: harmony-dev@incubator.apache.org Delivered-To: mailing list harmony-commits@incubator.apache.org Received: (qmail 28612 invoked by uid 99); 6 Feb 2006 15:51:34 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 06 Feb 2006 07:51:34 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Mon, 06 Feb 2006 07:51:33 -0800 Received: (qmail 55217 invoked by uid 65534); 6 Feb 2006 15:51:13 -0000 Message-ID: <20060206155113.55206.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r375302 [2/2] - in /incubator/harmony/standard/site: docs/ docs/documentation/ docs/images/ docs/subcomponents/classlibrary/ xdocs/ xdocs/documentation/ xdocs/images/ xdocs/subcomponents/classlibrary/ Date: Mon, 06 Feb 2006 15:51:09 -0000 To: harmony-commits@incubator.apache.org From: tellison@apache.org X-Mailer: svnmailer-1.0.6 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Added: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse.xml URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse.xml?rev=375302&view=auto ============================================================================== --- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse.xml (added) +++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse.xml Mon Feb 6 07:51:07 2006 @@ -0,0 +1,179 @@ + + + + + + + + Apache Harmony development using Eclipse + Harmony Documentation Team + + + +

+ These instructions will help you set up Eclipse to develop Java code + in Apache Harmony. +

+ There are two sets of instructions -- the fast path + for people who are + already familiar with Eclipse and the source code layout in Harmony's + Subversion repository; and the + step-by-step guide + for people who want to follow the details of a set-up, and see a brief + development example. +

+ Both sets of instructions assume you satisfy the same Eclipse-based + development prerequsities. +

+ + +

+ You may have heard or read about Harmony's strict rules for contributor's + eligibility. We take this seriously because a number of parties implement + Java, and we respect their rights to their property. If you have detailed + knowledge of another implementation of Java, and they have not explicitly + approved your participation in Harmony, please check whether we will be able + to accept your contribution by reading the + Apache Harmony contribution policy. +

+ +

+ To develop the class library Java code with Eclipse JDT you will need: +

Eclipse : version 3.2 integration build I20060119 or later, from + eclipse.org
Subclipse : Subversion plug-in from + tigris.org
a snapshot classlib build : from the + + download page. If you prefer to build a snapshot yourself the + instructions are here.
a compatible VM : obtain a VM as + described here capable + of running the class libary code, and install it in the same location as + the snapshot.

+ +

+ If you know your way around Eclipse JDT, then following these steps will + have you hacking Harmony Java code in no time at all! +

+ + +

+ Ensure that you have the development pre-requisites + in place, then: +

Launch Eclipse with the VM argument "-Dpde.jreProfile=none" + (i.e. eclipse -vmargs -Dpde.jreProfile=none).
Configure the following settings in Window > Preferences... +
- Change the Java compiler settings +
  1. In the Java > Compiler preferences ensure the + "Compiler compliance level" is set to + 1.4.
  2. In the Java > Compiler > Building preferences, + open the "Build Path Problems" section + and change "Circular Dependencies" from + Error to Warning.
- Change the PDE settings +
  1. In the Plug-in Development > Compilers preferences + change "Unresolved Dependencies" from + Error to Warning.
  2. In the Plug-in Development > Target Platform + preferences, change the "Location:" box to be the + jre/lib/boot directory of the classlib snapshot.
Create a SVN repository location to the Harmony classlib, using URL + https://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib

+ + + +

+ The Apache Harmony class library is structured to allow developers to work on individual + modules in the class library without having to load and compile the entire + project source tree. +

+ This is best illustrated by a worked example. In this example, assume you want to make + a change to the NIO module. This is how you would proceed: +

Go to the SVN repository view, open the Harmony URL and browse to + "trunk > modules". Select + "nio" and from the context menu select + Checkout..., and on the checkout dialog just + click "Finish"
In the resulting project in your workspace the implementation code + is in the source folder src/main/java and the unit tests + are in the source folder src/test/java.
Hack away! Developers are encouraged to produce JUnit tests for new + implementation code.
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 + AllTests suite for all tests in a package or module. + For example, to run the test suite + org.apache.harmony.tests.nio.AllTests set up a + run configuration with the following characteristics: +
- bootclasspath : the folder nio/bin/main, followed by + the Harmony JRE library.
- classpath : the folder nio/bin/test, followed by the + JUNIT JAR file.
- VM : the Harmony JRE as the launching VM.
+
If everything looks good, go ahead and + contribute a patch.

+ +

+ 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: +

eclipse -vmargs -Dpde.jreProfile=none

+ We pick up the story here... +

+ + + \ No newline at end of file Added: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse_movie.html URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse_movie.html?rev=375302&view=auto ============================================================================== --- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse_movie.html (added) +++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/dev_eclipse_movie.html Mon Feb 6 07:51:07 2006 @@ -0,0 +1,71 @@ + + + + + + + + + + + +

+ + +

+ +

+ + +

Eclipse-based development : The Movie

+ +

+ After watching the movie return to the Eclipse-based development page. +

+ + 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=375302&r1=375301&r2=375302&view=diff ============================================================================== --- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml (original) +++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml Mon Feb 6 07:51:07 2006 @@ -19,23 +19,33 @@ - - Apache Harmony - Harmony Documentation Team - + + Apache Harmony + Harmony Documentation Team + - +

-Lets talk about the class library -

- - - - - - - +

+ The following documentation links are specific to the class library effort underway at Apache Harmony. +

+ +

Building the Classlibrary Code +
+ Describes how to download and build the class library code from source. +
+

Development with the Eclipse IDE +
+ Describes how to set up Eclipse to develop the class library code. +
+

+ + +