harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From telli...@apache.org
Subject svn commit: r419717 - in /incubator/harmony/enhanced/classlib/trunk: README.txt RUNNING-TESTS.txt
Date Thu, 06 Jul 2006 22:02:40 GMT
Author: tellison
Date: Thu Jul  6 15:02:39 2006
New Revision: 419717

URL: http://svn.apache.org/viewvc?rev=419717&view=rev
Log:
Bringing the readme docs up to date.

Modified:
    incubator/harmony/enhanced/classlib/trunk/README.txt
    incubator/harmony/enhanced/classlib/trunk/RUNNING-TESTS.txt

Modified: incubator/harmony/enhanced/classlib/trunk/README.txt
URL: http://svn.apache.org/viewvc/incubator/harmony/enhanced/classlib/trunk/README.txt?rev=419717&r1=419716&r2=419717&view=diff
==============================================================================
--- incubator/harmony/enhanced/classlib/trunk/README.txt (original)
+++ incubator/harmony/enhanced/classlib/trunk/README.txt Thu Jul  6 15:02:39 2006
@@ -1,9 +1,17 @@
-
 README
 ======
 
 
-This directory contain the Harmony class library code.
+This directory contain the Apache Harmony class library code.
+
+Apache Harmony is an effort undergoing incubation at the Apache Software
+Foundation (ASF). Incubation is required of all newly accepted projects
+until a further review indicates that the infrastructure, communications,
+and decision making process have stabilized in a manner consistent with
+other successful ASF projects. While incubation status is not necessarily
+a reflection of the completeness or stability of the code, it does indicate
+that the project has yet to be fully endorsed by the ASF.
+
 
 Contents
 --------
@@ -21,18 +29,15 @@
               HTML documentation of the Java and C source using the Doxygen
               documentation system. Pre-genenerated HTML is included. 
                
-*  modules - Java source files that can be compiled into the class library
-              component files
-              
-*  native-src -  C language source files plus the required makefiles that
-                 together can be used to build the natives libraries required
-                 by the Java class library components to function correctly.
-                   
+*  modules  - Java, C/C++, assembly source files that can be compiled into the
+              class library component files.
+
+*  support  - Java source files used to support test cases across various modules.
 
 
 Pre-requisites for Building
 ---------------------------
-In order to build the Java and C source contained in the modules and native-src
+In order to build the source code contained in the modules and support
 directories, it is necessary to configure the following tools in the user 
 environment. That is, the working environment should be such that the PATH 
 environment variable contains all of the directories where the executables of
@@ -72,18 +77,16 @@
 
 Building
 --------
-The simplest way to get started is to change directory into
-<EXTRACT_DIR> and then type "ant" to run Apache Ant against the
-default target of the build.xml file. Provided that both a C compiler and a Java
-compiler are available, Ant will proceed to compile all Java source beneath
-the <EXTRACT_DIR>/modules folders and all C source beneath the
-<EXTRACT_DIR>/native-src folders.
+The simplest way to get started is to change directory into <EXTRACT_DIR> and
+then type "ant" to run Apache Ant against the default target of the build.xml
+file. Provided that the required compilers are available, Ant will proceed to
+compile all the class library source code .
 
 
 Building Java
 -------------
 The class files output from the Java compilation will be assembled into a set
-of JAR files which reflect the proposed components of the class libraries (see
+of JAR files which reflect the components of the class libraries (see
 http://wiki.apache.org/harmony/ClassLibrary for more information). Together with
 the required support files, these JAR files will then be laid out in the boot
 directory of the following directory tree structure ...
@@ -114,8 +117,8 @@
 
 Building Natives
 ----------------
-Next, the source files contained under <EXTRACT_DIR>/native-src will be
-built using the available C compiler. The output from this stage will be the 
+Next, the source files contained under <EXTRACT_DIR>/modules will be
+built using the available C/C++/ASM compiler. The output from this stage will be the 
 creation of a launcher executable (java.exe on Windows, java on Linux) in the 
 bin directory of the above layout together with a number of shared libraries
 (with the .dll extension on Windows, and .so on Linux). 
@@ -144,7 +147,7 @@
 
 * kernel_doc - contains HTML documentation on the set of Java classes called the
                "kernel classes". These are the set of classes which - under the
-               architecture proposed in this contribution - are closely tied to
+               Harmony class library architecture - are closely tied to
                the structure of the VM. 
                Browse <EXTRACT_DIR>/doc/kernel_doc/html/index.html
 
@@ -196,15 +199,9 @@
 What's Next ?
 -------------
 
-The class libraries do not provide the full J2SE
-API. Instead the included source is only a subset of the Java 1.5 API.
+The class libraries do not provide the full JSE API. Instead the included source
+is only a subset of the Java 1.5 API.
 
-In addition there is minimal support for the Java security framework. Users 
-wishing to experiment with introducing JCE support to these class libraries are 
-recommended to download the latest release of the Bouncy Castle Cryptography API
-and install the provider jar into the <EXTRACT_DIR>/deploy/jdk/jre/lib/ext
-location. 
-See http://www.bouncycastle.org
 
 To test out the functionality of the built class library components a compatible
 VM needs to be obtained.  A compatible VM implements the Virtual Machine Interface

Modified: incubator/harmony/enhanced/classlib/trunk/RUNNING-TESTS.txt
URL: http://svn.apache.org/viewvc/incubator/harmony/enhanced/classlib/trunk/RUNNING-TESTS.txt?rev=419717&r1=419716&r2=419717&view=diff
==============================================================================
--- incubator/harmony/enhanced/classlib/trunk/RUNNING-TESTS.txt (original)
+++ incubator/harmony/enhanced/classlib/trunk/RUNNING-TESTS.txt Thu Jul  6 15:02:39 2006
@@ -5,35 +5,23 @@
 
 The objective is to make it easy to run unit tests
 for any part of the classlibrary, and be able to also
-run the pile and do easy reporting.
-
-This is a work in progress.
+run all the tests and do easy reporting.
 
 Requirements : 
 
-1) Eclipse compiler and adapter.  http://www.eclipse.org
-   
-   Put these in your ant/lib
-
-   jdtCompilerAdapter.jar
-   org.eclipse.jdt.code_3.1.x.jar
-   
-   where x is arbitrary.  Right now, this can only be gotten
-   from the 106MB eclipse download.  Sorry.
-   
-2) JUnit.jar - any modern version. http://www.junit.org
+1) JUnit.jar - any modern version. http://www.junit.org
    
-   Put this on your ant/lib directory too.
+   Put this on your ant/lib directory.
    
-3) Ensure you have the build time dependencies installed, these
+2) Ensure you have the build time dependencies installed, these
    can be downloaded using the following command:
 
-   ant -f make/depends.xml download
+   ant fetch-depends
 
    Warning: Some of the dependencies are made available under
             licences other than the ASLv2.
   
-4) J9 VM from IBM (evaluation)
+3) J9 VM from IBM (evaluation)
     
       http://www-128.ibm.com/developerworks/java/jdk/harmony/index.html
       
@@ -50,14 +38,12 @@
  
  1) Build the classlibrary : 
  
-    $ cd make
     $ ant
     
     This should build and install all java and native components
     
  2) Test : 
  
-    in make dir : 
     
     $ ant test
     



Mime
View raw message