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

common.sh

Go to the documentation of this file.
00001  *
00002 /*!
00003  * @file ./jvm/common.sh
00004  *
00005  * @brief Common code for building the main JVM development area
00006  *
00007  * This script is common to @b build.sh and @b clean.sh and is not
00008  * designed to do anything on its own.
00009  *
00010  * Each of these directories contains a @b build.sh script.  In addition
00011  * to these, an Eclipse project file is available in each for use with
00012  * the Eclipse C/C++ plugin, so this entire directory tree may be
00013  * imported wholesale into an Eclipse workspace and used without
00014  * changes.  (Eclipse 3.0.2 generated these files.)  Notice that
00015  * the Eclipse setup does not build the documentation set.  This must
00016  * be done manually with the top-level 'build.sh dox'.
00017  *
00018  * Each of these directories also contains a @b clean.sh script which
00019  * removes the output of @b build.sh.
00020  *
00021  * @attention The configuration options stored by 'config.sh' into the
00022  * file @b config/confopts.gcc are @e not directly available to
00023  * Eclipse and @e must be manually entered there after they are
00024  * established by @link config.sh config.sh@endlink.  They
00025  * should be entered in the project build parameters for C/C++ in the
00026  * miscellaneous parameters section.  For example, '-m32' and '-m64'.
00027  * For a command line GCC invocation, the following is a convenient
00028  * way to incorporate the options:
00029  *
00030  * @verbatim
00031  *
00032  *   $ gcc `cat ../config/config_opts_always.gcc` \
00033  *         `cat ../config/config_opts_usually.gcc` -c filename.c ...
00034  *
00035  * @endverbatim
00036  *
00037  * Notice that this script may be run instead of or as well as an
00038  * Eclipse build.  The only difference is where the object files
00039  * are stored.
00040  *
00041  *
00042  * @see @link jvm/build.sh jvm/build.sh@endlink
00043  *
00044  * @see @link jvm/clean.sh jvm/clean.sh@endlink
00045  *
00046  * @see @link ./build.sh ./build.sh@endlink
00047  *
00048  * @see @link ./clean.sh ./clean.sh@endlink
00049  *
00050  * @internal Notice that 'jvm/*.sh' have the relative path prefix './'
00051  * attached to the front of the @@file directive.  This is to avoid an
00052  * interesting sensitivity in Doxygen that got confused between
00053  * 'jvm/filename.sh' and 'libjvm/filename.sh' and failed to produce
00054  * the "File List" entry for each 'jvm/*.sh' build script.  By marking
00055  * them './jvm/build.sh' et al, this behavior went away.  This same
00056  * comment may be found in @link ./config.sh config.sh@endlink
00057  *
00058  *
00059  * @todo  A Windows .BAT version of this script needs to be written
00060  *
00061  *
00062  * @section Control
00063  *
00064  * \$URL: https://svn.apache.org/path/name/common.sh $ \$Id: common.sh 0 09/28/2005 dlydick $
00065  *
00066  * Copyright 2005 The Apache Software Foundation
00067  * or its licensors, as applicable.
00068  *
00069  * Licensed under the Apache License, Version 2.0 ("the License");
00070  * you may not use this file except in compliance with the License.
00071  * You may obtain a copy of the License at
00072  *
00073  *     http://www.apache.org/licenses/LICENSE-2.0
00074  *
00075  * Unless required by applicable law or agreed to in writing,
00076  * software distributed under the License is distributed on an
00077  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
00078  * either express or implied.
00079  *
00080  * See the License for the specific language governing permissions
00081  * and limitations under the License.
00082  *
00083  * @version \$LastChangedRevision: 0 $
00084  *
00085  * @date \$LastChangedDate: 09/28/2005 $
00086  *
00087  * @author \$LastChangedBy: dlydick $
00088  *         Original code contributed by Daniel Lydick on 09/28/2005.
00089  *
00090  * @section Reference
00091  *
00092  */ /* 
00093  * (Use  #! and #/ with dox_filter.sh to fool Doxygen into
00094  * parsing this non-source text file for the documentation set.
00095  * Use the above open comment to force termination of parsing
00096  * since it is not a Doxygen-style 'C' comment.)
00097  *
00098  *
00099  *##################################################################
00100  *
00101  * Script setup
00102  *
00103  *
00104  * EOF
00105 

Generated on Fri Sep 30 18:59:23 2005 by  doxygen 1.4.4