Main Page | Namespace List | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

INSTALL

Go to the documentation of this file.
00001 /*!
00002  * @file ./INSTALL
00003  *
00004  * @brief Installation procedure.
00005  *
00006  * @section Control
00007  *
00008  * \$URL: https://svn.apache.org/path/name/INSTALL $ \$Id: INSTALL 0 09/28/2005 dlydick $
00009  *
00010  * Copyright 2005 The Apache Software Foundation
00011  * or its licensors, as applicable.
00012  * 
00013  * Licensed under the Apache License, Version 2.0 ("the License");
00014  * you may not use this file except in compliance with the License.
00015  * You may obtain a copy of the License at
00016  * 
00017  *     http://www.apache.org/licenses/LICENSE-2.0
00018  * 
00019  * Unless required by applicable law or agreed to in writing,
00020  * software distributed under the License is distributed on an
00021  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
00022  * either express or implied.
00023  * 
00024  * See the License for the specific language governing permissions
00025  * and limitations under the License.
00026  *
00027  *
00028  * @version \$LastChangedRevision: 0 $
00029  *
00030  * @date \$LastChangedDate: 09/28/2005 $
00031  *
00032  * @author \$LastChangedBy: dlydick $
00033  *         Original code contributed by Daniel Lydick on 09/28/2005.
00034  *
00035  *
00036  * @section Reference
00037  *
00038  * @see ./README
00039  *
00040  * @verbatim
00041 
00042 
00043 Apache Harmony BootJVM Source Installation Procedure
00044 ----------------------------------------------------
00045 
00046 1.  Tar extract produces the directory tree where you
00047     have found this file (obviously you have done this
00048     part already).
00049 
00050 2.  Run 'config.sh' and answer the questions to create a
00051     valid compilation and runtime environment and optionally build
00052     the configured components for the first time (via 'build.sh cfg').
00053 
00054 3.  Run 'build.sh cfg' thereafter to compile all configured
00055     components.  Run 'build.sh all' to compile all components,
00056     regardless of those configured.  Run 'build.sh help' for a
00057     list of build options.  Results are stored in:
00058 
00059         jvm/bin/bootjvm
00060         libjvm/lib/libjvm.a
00061         main/bin/bootjvm
00062         test/bin/*.class
00063         jni/src/harmony/generic/0.0/bin/bootjvm
00064         jni/src/harmony/generic/0.0/bin/*.class
00065         doc/*
00066 
00067 
00068 4.  Run 'clean.sh' to remove compiled output, with the same
00069     arguments as for 'build.sh'.
00070 
00071 5.  Project files for Eclipse have also been provided
00072     for those who wish to use the Eclipse IDE.  Although
00073     the intermediate objects are stored in a slightly
00074     different location, the results are in the same places.
00075     Notice that the 'jni/bin' directory is an artifact
00076     of Eclipse, where 'jni/src/vendor/product/version/bin'
00077     is affilliated with these project build scripts.
00078     A source distribution may not be created until this
00079     directory has been removed, either explicitly or via
00080     an Eclipse 'clean' operation on the 'jni' project.
00081 
00082 6.  To produce a source-only distribution, run 'dist-src.sh'.  The
00083     release levelof this distribution will be the same as found in
00084     'config/config.h' when 'config.sh' was last run.  If the release
00085     number is to be different than that, please run 'config.sh' again
00086     and rebuild the whole project, then run the distribution script
00087     again.
00088 
00089 7.  To produce a binary-only distribution, run 'dist-bin.sh'.  The
00090     release level of this distribution will be the same as found in
00091     'config/config.h' when 'config.sh' was last run.  If the release
00092     number is to be different than that, please run 'config.sh' again
00093     and rebuild the whole project, then run the distribution script
00094     again.
00095 
00096 8.  Due to a Doxygen constraint concerning files with the same
00097     name that are found in different directories, there are three
00098     shell scripts in the top level directory that have absolute path
00099     names in their "@file" declaration.  Please change these to your
00100     install area so that the documentation compiles without errors.
00101     The file names are: ./build.sh and ./clean.sh and ./common.sh .
00102     The author apologizes for any inconvenience that this may cause.
00103     If you know of a better way around this constraint, please speak up.
00104 
00105 9.  Show the run time help menu by running either
00106     'jvm/bin/bootjvm -help' or 'main/bin/bootjvm -help'.
00107 
00108 10. Work hard.
00109 
00110 11. Be creative.
00111 
00112 12. Produce the best Java Virtual Machine in the industry.
00113     Make it a true work of art that will be worthy of the
00114     Apache brand!
00115 
00116 @endverbatim
00117  *
00118  */
00119  */ /* 
00120  * (Use  #! and #/ with dox_filter.sh to fool Doxygen into
00121  * parsing this non-source text file for the documentation set.
00122  * Use the above open comment to force termination of parsing
00123  * since it is not a Doxygen-style 'C' comment.)
00124  *
00125  * EOF
00126 

Generated on Fri Sep 30 18:48:54 2005 by  doxygen 1.4.4