Return-Path: Delivered-To: apmail-harmony-commits-archive@www.apache.org Received: (qmail 68698 invoked from network); 3 Oct 2007 14:09:37 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 3 Oct 2007 14:09:37 -0000 Received: (qmail 41933 invoked by uid 500); 3 Oct 2007 14:09:27 -0000 Delivered-To: apmail-harmony-commits-archive@harmony.apache.org Received: (qmail 41846 invoked by uid 500); 3 Oct 2007 14:09:26 -0000 Mailing-List: contact commits-help@harmony.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@harmony.apache.org Delivered-To: mailing list commits@harmony.apache.org Received: (qmail 41837 invoked by uid 99); 3 Oct 2007 14:09:26 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 03 Oct 2007 07:09:26 -0700 X-ASF-Spam-Status: No, hits=-100.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 03 Oct 2007 14:09:25 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 195F41A9832; Wed, 3 Oct 2007 07:09:05 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r581607 - in /harmony/standard/site: docs/quickhelp_contributors.html xdocs/quickhelp_contributors.xml Date: Wed, 03 Oct 2007 14:09:04 -0000 To: commits@harmony.apache.org From: nadinem@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20071003140905.195F41A9832@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: nadinem Date: Wed Oct 3 07:09:03 2007 New Revision: 581607 URL: http://svn.apache.org/viewvc?rev=581607&view=rev Log: HARMONY-4893: improving structure of QH doc Modified: harmony/standard/site/docs/quickhelp_contributors.html harmony/standard/site/xdocs/quickhelp_contributors.xml Modified: harmony/standard/site/docs/quickhelp_contributors.html URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/quickhelp_contributors.html?rev=581607&r1=581606&r2=581607&view=diff ============================================================================== --- harmony/standard/site/docs/quickhelp_contributors.html (original) +++ harmony/standard/site/docs/quickhelp_contributors.html Wed Oct 3 07:09:03 2007 @@ -182,24 +182,49 @@ Getting Started For Contributors

- This document explains how to get configured to build and - work with the Apache Harmony source code. The build is evolving. - If you come across a problem, double-check the + Follow these instructions to get configured to build and + work with the Apache Harmony source code. To get the Harmony code + and build it, follow these steps:

+ Get all required prerequisites. +
+ Check out the source code. +
+ Build the source code. +

+ After successfully building the source code, you will be able to + run Java* applications with Harmony. +

+ If you only need specific parts of the source code and not the whole HDK + (Harmony Java developer's kit), you can follow + component-wise instructions. +

Note:

+ The build is evolving. If you come across a problem, double-check the mailing list: - your issue may have been already discovered and resolved. + your issue may have been already discovered and resolved. Otherwise, + you can write a new mail to ask for help and support.

- Prerequisites + 1. Prerequisites

Basic Prerequisites

The tools you must have to be able to work with Harmony are:

The tools you must have to be able to work with Harmony are: +

- Apache Ant version 1.6.5 or later + Apache Ant version 1.6.5
Subversion @@ -248,19 +273,26 @@
- Microsoft 32-bit C/C++ Compiler, version 7 or higher
- Windows platform SDK
- - - Intel C++ Compiler - , version 9.0 -
- Microsoft Visual Studio.NET 2003
- + Compiler: +
  - Microsoft 32-bit C/C++ Compiler, version 7 or higher
  - + + Intel C++ Compiler, version 9.0 +
  +
@@ -306,23 +338,21 @@
- Cpp Tasks - collection, version 1.0 beta 3 or higher (downloaded) + Cpp Tasks collection, + version 1.0 beta 3 or higher (downloaded)
- Ant-Contrib - collection of tasks, version 0.6 or higher (downloaded) + Ant-Contrib collection of tasks, + version 0.6 or higher (downloaded)
Zlib library, binaries, version 1.2.1 or higher (downloaded)
- - Apache Portable - Runtime Layer - , version 1.2.6 (downloaded) + Apache Portable Runtime Layer, + version 1.2.6 (downloaded)
APR-util, @@ -351,61 +381,104 @@ build do that for you.
-
Back to top
-
- Getting the Source Code -
- +
- Checking out the Federated Build Tree + 2. Checking out the Federated Build Tree

- The Harmony codebase is divided into many separate parts. To create - a working JRE, you need a class library and a virtual machine. To - obtain these tools, use the federated build tree and then work - within the class library directory and the VM directory as you choose. - Currently, the federated build uses the DRLVM virtual machine. -
+ The Harmony codebase is divided into many separate parts. To create + a working JRE, you need a class library and a virtual machine. To + obtain these tools, use the federated build tree and then work + within the class library directory and the VM directory as you choose. + Currently, the federated build uses the DRLVM virtual machine. +

- To check out the federated build, use the following command: -
-
```
-$ svn co https://svn.apache.org/repos/asf/harmony/enhanced/trunk
```
+ To check out the federated build, use the following command: +
+
```
$ svn co https://svn.apache.org/repos/asf/harmony/enhanced/trunk 
```
- The given command checks out a directory structure that - contains working_classlib and working_vm - directories. After you populate the source trees in the next step, - working_classlib - will be the checkout of the class library SVN tree - and working_vm will be the checkout - of the DRLVM SVN tree. -
+ This command checks out a directory structure that + contains working_classlib and working_vm + directories. After you populate the source trees in the next step, + working_classlib + will be the checkout of the class library SVN tree + and working_vm will be the checkout + of the DRLVM SVN tree. +

Note

- If the root of the federated build is multiple levels deep in - your file system, the very long paths within class library might - result in a SVN checkout failure on Windows. The solution is to - move the tree upwards in your file system or switch operating systems. -
+ If the root of the federated build is multiple levels deep in + your file system, the very long paths within class library might + result in a SVN checkout failure on Windows. The solution is to + move the tree upwards in your file system or switch operating systems. +
+ + +
+ 3. Starting the Federated Build +
+ +
+ Now you should be ready to build the code. For the first time you build, + you might want to fetch all the dependencies. + If you do not, or if in the future a new dependency is added, the build will tell + you what to do, so that you can do this step periodically. To fetch the + dependencies and check out, build, and package snapshots of the JRE and HDK, type + the following command in the root directory of the federated build: +
+
```
$ ant -Dauto.fetch=true
```
- If you type ant in the root directory of federated build, - you will checkout, build, and package snapshots of the JRE and HDK. - However, as this approach builds the full JDK, it can be inconvenient - for a developer focused on a specific area, so please continue - with the next steps. -
+ This variant of command downloads all the required third-party components that can be + distributed under licences different from the Apache license; see THIRD_PARTY_NOTICES.txt + in the root directory for details. This is only needed during your first build. For + subsequent builds, just type: +
+
```
$ ant
```
Note

- If you do choose to build from the federated build root, you may need to - increase the Java heap available to Ant. We suggest setting the "ANT_OPTS" environment + If you choose to build from the federated build root, you may need to + increase the Java heap available to Ant. We suggest setting the "ANT_OPTS" environment variable as ANT_OPTS='-Xms256m -Xmx512m' in the manner appropriate for your operating system. -
+
+
+ Because running Ant in the root directory builds the full JDK, it can be inconvenient + for a developer focused on a specific area. If you are not interested in building + the full HDK, follow the detailed instructions + to build each JRE component separately. +
+
Back to top
+
+ Detailed Building Instructions +
+
If you do not need to build the whole HDK and did not execute ant + in step 3, follow these instructions to + build each component in turn and assemble the JRE from them. The building + procedure consists of the following steps:
+
1. + + Populate the source trees. + +
2. + Update the source trees. +
3. + Build the class library source code. +
4. + Build the DRLVM source code. +
5. + Combine class libraries and VM into JRE. +
- Populating the VM and ClassLibrary Source Trees + 1. Populating the Source Trees

@@ -428,7 +501,7 @@
- Updating the VM and ClassLibrary Source Trees + 2. Updating the Source Trees

@@ -452,21 +525,17 @@
```
$ ant clean
```
-
Back to top
-
- Building the Code -
-
- Now you should be ready to build the code. First build - the class library because DRLVM has a dependency on it and also - assembles a working JRE as part of its build. -

- Building the Class Library + 3. Building the Class Library

+ Now you should be ready to build the code. First build + the class library because DRLVM has a dependency on it and also + assembles a working JRE as part of its build. +
+
For the first time you build, you might want to fetch all the class library dependencies. If you do not, or if in the future a new dependency is added, the build will tell you what to do, so that you @@ -491,7 +560,7 @@
- Building DRLVM + 4. Building DRLVM

- Prerequisites + 1. Prerequisites

- Getting the Source Code -

- Checking out the Federated Build Tree + 2. Checking out the Federated Build Tree

+ 3. Starting the Federated Build +

+ Detailed Building Instructions +

- Populating the VM and ClassLibrary Source Trees + 1. Populating the Source Trees

- Updating the VM and ClassLibrary Source Trees + 2. Updating the Source Trees

- Building the Code -

- Building the Class Library + 3. Building the Class Library

- Building DRLVM + 4. Building DRLVM

- Combining JRE from Built Components + 5. Combining JRE from Built Components