Add feedback from Vikram
[oota-llvm.git] / docs / MakefileGuide.html
index af06d757120dd088e0142f9f945eb0fe078d2d20..3c73753be1c5ffa9a4f4fb857eadbf6ad7b8b9e5 100644 (file)
     <ol>
       <li><a href="#projects">Projects</a></li>
       <li><a href="#varvals">Variable Values</a></li>
-      <li><a href="#including">Including Makefiles</a></li>
-      <ol>
-        <li><a href="#Makefile">Makefile</a></li>
-        <li><a href="#Makefile.common">Makefile.common</a></li>
-        <li><a href="#Makefile.config">Makefile.config</a></li>
-        <li><a href="#Makefile.rules">Makefile.rules</a></li>
-      </ol>
+      <li><a href="#including">Including Makefiles</a>
+        <ol>
+          <li><a href="#Makefile">Makefile</a></li>
+          <li><a href="#Makefile.common">Makefile.common</a></li>
+          <li><a href="#Makefile.config">Makefile.config</a></li>
+          <li><a href="#Makefile.rules">Makefile.rules</a></li>
+        </ol>
+      </li>
       <li><a href="#Comments">Comments</a></li>
     </ol>
   </li>
   <li><a href="#tutorial">Tutorial</a>
     <ol>
-      <li><a href="#libraries">Libraries</a></li>
-      <li><a href="#tools">Tools</a></li>
+      <li><a href="#libraries">Libraries</a>
+        <ol>
+         <li><a href="#Modules">Bytecode Modules</a></li>
+       </ol>
+      </li>
+      <li><a href="#tools">Tools</a>
+        <ol>
+         <li><a href="#JIT">JIT Tools</a></li>
+       </ol>
+      </li>
+      <li><a href="#projects">Projects</a></li>
     </ol>
   </li>
   <li><a href="#targets">Targets Supported</a>
       <li><a href="#dist-check">dist-check</a></li>
       <li><a href="#dist-clean">dist-clean</a></li>
       <li><a href="#install">install</a></li>
+      <li><a href="#preconditions">preconditions</a></li>
       <li><a href="#printvars">printvars</a></li>
+      <li><a href="#reconfigure">reconfigure</a></li>
+      <li><a href="#spotless">spotless</a></li>
       <li><a href="#tags">tags</a></li>
       <li><a href="#uninstall">uninstall</a></li>
     </ol>
   software, but it can build yours too. Built into the system is knowledge of
   the <tt>llvm/projects</tt> directory. Any directory under <tt>projects</tt>
   that has both a <tt>configure</tt> script and a <tt>Makefile</tt> is assumed
-  to be a project that uses the LLVM Makefile system. This allows your project
+  to be a project that uses the LLVM Makefile system.  Building software that
+  uses LLVM does not require the LLVM Makefile System nor even placement in the
+  <tt>llvm/projects</tt> directory. However, doing so will allow your project
   to get up and running quickly by utilizing the built-in features that are used
   to compile LLVM. LLVM compiles itself using the same features of the makefile
   system as used for projects.</p>
+  <p>For complete details on setting up your projects configuration, simply
+  mimic the <tt>llvm/projects/sample</tt> project or for further details, 
+  consult the <a href="Projects.html">Projects.html</a> page.</p>
 </div>
 
 <!-- ======================================================================= -->
   <tt>Makefile</tt>. This is the file first read by <tt>make</tt>. It has three
   sections:</p>
   <ol>
-    <li><a href="setvars">Settable Variables</a> - Required that must be set
+    <li><a href="#setvars">Settable Variables</a> - Required that must be set
     first.</li>
-    <li><a href="Makefile.common">include <tt>$(LEVEL)/Makefile.common</tt></a>
+    <li><a href="#Makefile.common">include <tt>$(LEVEL)/Makefile.common</tt></a>
     - include the LLVM Makefile system.
-    <li><a href="overvars">Override Variables</a> - Override variables set by
+    <li><a href="#overvars">Override Variables</a> - Override variables set by
     the LLVM Makefile system.
   </ol>
 </div>
   <ol>
     <li>It includes the project's configuration makefile to obtain values
     determined by the <tt>configure</tt> script. This is done by including the
-    <a href="Makefile.config"><tt>$(LEVEL)/Makefile.config</tt></a> file.</li>
+    <a href="#Makefile.config"><tt>$(LEVEL)/Makefile.config</tt></a> file.</li>
     <li>It specifies any other (static) values that are needed throughout the
     project. Only values that are used in all or a large proportion of the
     project's directories should be placed here.</li>
     <li>It includes the standard rules for the LLVM Makefile system,
-    <a href="Makefile.rules"><tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt></a>. 
+    <a href="#Makefile.rules"><tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt></a>. 
     This file is the "guts" of the LLVM Makefile system.</li>
   </ol>
 </div>
   <p>This file, located at <tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt> is the heart
   of the LLVM Makefile System. It provides all the logic, dependencies, and
   rules for building the targets supported by the system. What it does largely
-  depends on the values of <tt>make</tt> <a href="variables">variables</a> that
+  depends on the values of <tt>make</tt> <a href="#variables">variables</a> that
   have been set <em>before</em> <tt>Makefile.rules</tt> is included.
 </div>
 
 <div class="doc_subsection"><a name="Comments">Comments</a></div>
 <div class="doc_text">
   <p>User Makefiles need not have comments in them unless the construction is
-  unusual or it doesn't strictly follow the rules and patterns of the LLVM
+  unusual or it does not strictly follow the rules and patterns of the LLVM
   makefile system. Makefile comments are invoked with the pound (#) character.
   The # character and any text following it, to the end of the line, are ignored
   by <tt>make</tt>.</p>
   Note that you normally do not need to specify the sources involved. The LLVM
   Makefile system will infer the source files from the contents of the source
   directory.</p>
+  <p>The <tt>LOADABLE_MODULE=1</tt> directive can be used in conjunction with
+  <tt>SHARED_LIBRARY=1</tt> to indicate that the resulting shared library should
+  be openable with the <tt>dlopen</tt> function and searchable with the
+  <tt>dlsym</tt> function (or your operating system's equivalents). While this
+  isn't strictly necessary on Linux and a few other platforms, it is required
+  on systems like HP-UX and Darwin. You should use <tt>LOADABLE_MODULE</tt> for
+  any shared library that you intend to be loaded into an tool via the
+  <tt>-load</tt> option. See the 
+  <a href="WritingAnLLVMPass.html#makefile">WritingAnLLVMPass.html</a> document
+  for an example of why you might want to do this.
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="Modules">Bytecode Modules</a></div>
+<div class="doc_text">
+  <p>In some situations, it is desireable to build a single bytecode module from
+  a variety of sources, instead of an archive, shared library, or bytecode 
+  library. Bytecode modules can be specified in addition to any of the other
+  types of libraries by defining the <a href="#MODULE_NAME">MODULE_NAME</a>
+  variable. For example:</p>
+  <pre><tt>
+      LIBRARYNAME = mylib
+      BYTECODE_LIBRARY = 1
+      MODULE_NAME = mymod
+  </tt></pre>
+  <p>will build a module named <tt>mymod.bc</tt> from the sources in the
+  directory. This module will be an aggregation of all the bytecode modules 
+  derived from the sources. The example will also build a bytecode archive 
+  containing a bytecode module for each compiled source file. The difference is
+  subtle, but important depending on how the module or library is to be linked.
+  </p>
 </div>
 
 <!-- ======================================================================= -->
   </p>
 </div>
 
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="JIT">JIT Tools</a></div>
+<div class="doc_text">
+  <p>Many tools will want to use the JIT features of LLVM. However, getting the
+  right set of libraries to link with is tedious, platform specific, and error 
+  prone. Additionally, the JIT has special linker switch options that it needs.
+  Consequently, to make it easier to build tools that use the JIT, you can 
+  use a special value for the <tt>LLVMLIBS</tt> variable:</p>
+  <pre><tt>
+      TOOLNAME = my_jit_tool
+      USEDLIBS = mylib
+      LLVMLIBS = JIT
+  </tt></pre>
+  <p>Using a value of <tt>JIT</tt> for <tt>LLVMLIBS</tt> tells the makefile
+  system to construct a special value for LLVMLIBS that gives the program all
+  the LLVM libraries needed to run the JIT. Any additional libraries needed can
+  still be specified with <tt>USEDLIBS</tt>. To get a full understanding of how
+  this changes the linker command, it is recommended that you:</p>
+  <pre><tt>
+      cd examples/Fibonacci
+      make VERBOSE=1
+  </tt></pre>
+  <p>By default, using <tt>LLVMLIBS=JIT</tt> will link in enough to support JIT
+  code generation for the architecture on which the tool is linked. If you need
+  additional target architectures linked in, you may specify them on the command
+  line or in your <tt>Makefile</tt>. For example:</p>
+  <pre><tt>
+      ENABLE_X86_JIT=1
+      ENABLE_SPARCV9_JIT=1
+      ENALBE_PPC_JIT=1
+  </tt></pre>
+  <p>will cause the tool to be able to generate code for all three platforms.
+  </p>
+</div>
+
 <!-- *********************************************************************** -->
 <div class="doc_section"><a name="targets">Targets Supported</a></div>
 <!-- *********************************************************************** -->
 <div class="doc_text">
   <p>This section describes each of the targets that can be built using the LLVM
   Makefile system. Any target can be invoked from any directory but not all are
-  applicable to a given directory (e.g. "dist" and "install" will always operate
-  as if invoked from the top level directory).</p>
+  applicable to a given directory (e.g. "check", "dist" and "install" will
+  always operate as if invoked from the top level directory).</p>
 
   <table style="text-align:left">
-    <tr><th>Target Name</th><th>Implied Targets</th><th>Target Description</th></tr>
+    <tr>
+      <th>Target Name</th><th>Implied Targets</th><th>Target Description</th>
+    </tr>
     <tr><td><a href="#all"><tt>all</tt></a></td><td></td>
       <td>Compile the software recursively. Default target.
     </td></tr>
     <tr><td><a href="#all-local"><tt>all-local</tt></a></td><td></td>
       <td>Compile the software in the local directory only.
     </td></tr>
-    <tr><td><a href="#check"><tt>check</tt></a></td><td>all</td>
-      <td>Test the software recursively.
+    <tr><td><a href="#check"><tt>check</tt></a></td><td></td>
+      <td>Change to the <tt>test</tt> directory in a project and run the
+      test suite there.
     </td></tr>
-    <tr><td><a href="#check-local"><tt>check-local</tt></a></td><td>all-local</td>
-      <td>Test the software in the local directory only.
+    <tr><td><a href="#check-local"><tt>check-local</tt></a></td><td></td>
+      <td>Run a local test suite. Generally this is only defined in the 
+        <tt>Makefile</tt> of the project's <tt>test</tt> directory.
     </td></tr>
     <tr><td><a href="#clean"><tt>clean</tt></a></td><td></td>
       <td>Remove built objects recursively.
     <tr><td><a href="#dist"><tt>dist</tt></a></td><td>all</td>
       <td>Prepare a source distribution tarball.
     </td></tr>
-    <tr><td><a href="#dist-check"><tt>dist-check</tt></a></td><td>all check</td>
+    <tr><td><a href="#dist-check"><tt>dist-check</tt></a></td><td>all</td>
       <td>Prepare a source distribution tarball and check that it builds.
     </td></tr>
     <tr><td><a href="#dist-clean"><tt>dist-clean</tt></a></td><td>clean</td>
     <tr><td><a href="#install"><tt>install</tt></a></td><td>all</td>
       <td>Copy built objects to installation directory.
     </td></tr>
+    <tr><td><a href="#preconditions"><tt>preconditions</tt></a></td><td>all</td>
+      <td>Check to make sure configuration and makefiles are up to date.
+    </td></tr>
     <tr><td><a href="#printvars"><tt>printvars</tt></a></td><td>all</td>
       <td>Prints variables defined by the makefile system (for debugging).
     </td></tr>
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="check">check</a></div>
 <div class="doc_text">
-  <p>This target is used to perform any functional, unit or sanity tests as the
-  software is being built. The <tt>check</tt> target depends on the 
-  <a href="#all"><tt>all</tt></a> target so the software is built in each
-  directory first and then the "check" is applied.</p>
-  <p>The definition of "check" is pretty general. It depends on the value of the
-  <a href="#TESTS"><tt>TESTS</tt></a> variable. This variable should be set to a 
-  list of executables to run in order to test the software.  If they all return 
-  0 then the check succeeds, otherwise not. The programs run can be anything but
-  they should either be local to the directory or in your path.</p>
+  <p>This target can be invoked from anywhere within a project's directories
+  but always invokes the <a href="#check-local"><tt>check-local</tt></a> target 
+  in the project's <tt>test</tt> directory, if it exists and has a 
+  <tt>Makefile</tt>. A warning is produced otherwise.  If 
+  <a href="#TESTSUITE"><tt>TESTSUITE</tt></a> is defined on the <tt>make</tt>
+  command line, it will be passed down to the invocation of 
+  <tt>make check-local</tt> in the <tt>test</tt> directory. The intended usage 
+  for this is to assist in running specific suites of tests. If
+  <tt>TESTSUITE</tt> is not set, the implementation of <tt>check-local</tt> 
+  should run all normal tests.  It is up to the project to define what 
+  different values for <tt>TESTSUTE</tt> will do. See the 
+  <a href="TestingGuide.html">TestingGuide</a> for further details.</p>
 </div>
 
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="check-local">check-local</a></div>
 <div class="doc_text">
-  <p>This target does the same thing as <tt>check</tt> but only for the current
-  (local) directory.</p>
+  <p>This target should be implemented by the <tt>Makefile</tt> in the project's
+  <tt>test</tt> directory. It is invoked by the <tt>check</tt> target elsewhere.
+  Each project is free to define the actions of <tt>check-local</tt> as 
+  appropriate for that project. The LLVM project itself uses dejagnu to run a 
+  suite of feature and regresson tests. Other projects may choose to use 
+  dejagnu or any other testing mechanism.</p>
 </div>
 
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="clean">clean</a></div>
 <div class="doc_text">
   <p>This target cleans the build directory, recursively removing all things
-  that the Makefile builds. Despite once or twice attempting to remove /*, the
-  cleaning rules have been made guarded so they shouldn't go awry.</p>
+  that the Makefile builds. The cleaning rules have been made guarded so they 
+  shouldn't go awry (via <tt>rm -f $(UNSET_VARIABLE)/*</tt> which will attempt
+  to erase the entire directory structure.</p>
 </div>
 
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="install">install</a></div>
 <div class="doc_text">
   <p>This target finalizes shared objects and executables and copies all
-  libraries, headers and executables to the directory given with the 
-  <tt>--prefix</tt> option to <tt>configure</tt>.  When completed, the prefix
-  directory will have everything needed to <b>use</b> LLVM. </p>
+  libraries, headers, executables and documentation to the directory given 
+  with the <tt>--prefix</tt> option to <tt>configure</tt>.  When completed, 
+  the prefix directory will have everything needed to <b>use</b> LLVM. </p>
+  <p>The LLVM makefiles can generate complete <b>internal</b> documentation 
+  for all the classes by using <tt>doxygen</tt>. By default, this feature is 
+  <b>not</b> enabled because it takes a long time and generates a massive 
+  amount of data (>100MB). If you want this feature, you must configure LLVM
+  with the --enable-doxygen switch and ensure that a modern version of doxygen
+  (1.3.7 or later) is available in your <tt>PATH</tt>. You can download 
+  doxygen from 
+  <a href="http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc">
+  here</a>.
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="preconditions">preconditions</a></div>
+<div class="doc_text">
+  <p>This utility target checks to see if the <tt>Makefile</tt> in the object
+  directory is older than the <tt>Makefile</tt> in the source directory and
+  copies it if so. It also reruns the <tt>configure</tt> script if that needs to
+  be done and rebuilds the <tt>Makefile.config</tt> file similarly. Users may
+  overload this target to ensure that sanity checks are run <em>before</em> any
+  building of targets as all the targets depend on <tt>preconditions</tt>.</p>
 </div>
 
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="printvars">printvars</a></div>
 <div class="doc_text">
-  <p>This utility target just causes LLVM to print out some of its variables so
-  that you can double check how things are set. </p>
+  <p>This utility target just causes the LLVM makefiles to print out some of 
+  the makefile variables so that you can double check how things are set. </p>
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="reconfigure">reconfigure</a></div>
+<div class="doc_text">
+  <p>This utility target will force a reconfigure of LLVM or your project. It 
+  simply runs <tt>$(PROJ_OBJ_ROOT)/config.status --recheck</tt> to rerun the
+  configuration tests and rebuild the configured files. This isn't generally
+  useful as the makefiles will reconfigure themselves whenever its necessary.
+  </p>
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="spotless">spotless</a></div>
+<div class="doc_text">
+  <p>This utility target, only available when <tt>$(PROJ_OBJ_ROOT)</tt> is not 
+  the same as <tt>$(PROJ_SRC_ROOT)</tt>, will completely clean the
+  <tt>$(PROJ_OBJ_ROOT)</tt> directoy by removing its content entirely and 
+  reconfiguring the directory. This returns the <tt>$(PROJ_OBJ_ROOT)</tt> 
+  directory to a completely fresh state. All content in the directory except 
+  configured files and top-level makefiles will be lost.</p>
+  <div class="doc_warning"><p>Use with caution.</p></div>
 </div>
 
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="setvars">Control Variables</a></div>
 <div class="doc_text">
   <p>Variables listed in the table below should be set <em>before</em> the 
-  inclusion of <a href="Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>. 
+  inclusion of <a href="#Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.
   These variables provide input to the LLVM make system that tell it what to do 
   for the current directory.</p>
   <dl>
     <dt><a name="BUILT_SOURCES"><tt>BUILT_SOURCES</tt></a></dt>
     <dd>Specifies a set of source files that are generated from other source
     files. These sources will be built before any other target processing to 
-    ensure they are present.</td>
+    ensure they are present.</dd>
     <dt><a name="BYTECODE_LIBRARY"><tt>BYTECODE_LIBRARY</tt></a></dt>
     <dd>If set to any value, causes a bytecode library (.bc) to be built.</dd>
     <dt><a name="CONFIG_FILES"><tt>CONFIG_FILES</tt></a></dt>
     source files, all built sources, all Makefiles, and most documentation files 
     will be automatically distributed. Use this variable to distribute any 
     files that are not automatically distributed.</dd>
+    <dt><a name="FAKE_SOURCES"><tt>FAKE_SOURCES</tt><small>(optional)</small>
+    </a></dt>
+    <dd>This variable is like <a href="#SOURCES"><tt>SOURCES</tt></a> except that
+    the source files don't need to exist. The makefiles only use
+    <tt>FAKE_SOURCES</tt> to create the names of derived objects that should be
+    included in the directory's result. It is assumed that the project's
+    <tt>Makefile</tt> will define how to build the derived objects
+    necessary.</dd>
     <dt><a name="KEEP_SYMBOLS"><tt>KEEP_SYMBOLS</tt></a></dt>
     <dd>If set to any value, specifies that when linking executables the
     makefiles should retain debug symbols in the executable. Normally, symbols
     are stripped from the executable.</dd>
-    <dt><a name="LEVEL"><tt>LEVEL</tt></a><small>(required)</dt>
+    <dt><a name="LEVEL"><tt>LEVEL</tt></a><small>(required)</small></dt>
     <dd>Specify the level of nesting from the top level. This variable must be
     set in each makefile as it is used to find the top level and thus the other
     makefiles.</dd>
     <dt><a name="LIBRARYNAME"><tt>LIBRARYNAME</tt></a></dt>
-    <dd>Specify the name of the library to be built. (Required For Libraries)</dd>
-    <a href="#BUILD_OBJ_DIR"><tt>BUILD_OBJ_DIR<tt></a> directory.</dd>
+    <dd>Specify the name of the library to be built. (Required For
+    Libraries)</dd>
     <dt><a name="LLVMLIBS"><tt>LLVMLIBS</tt></a></dt>
     <dd>Specifies the set of libraries from the LLVM $(ObjDir) that will be
     linked into the tool or library.</dd>
+    <dt><a name="LOADABLE_MODULE"><tt>LOADABLE_MODULE</tt></a></dt>
+    <dd>If set to any value, causes the shared library being built to also be
+    a loadable module. Loadable modules can be opened with the dlopen() function
+    and searched with dlsym (or the operating system's equivalent). Note that
+    setting this variable without also setting <tt>SHARED_LIBRARY</tt> will have
+    no effect.</dd>
+    <dt><a name="MODULE_NAME"><tt>MODULE_NAME</tt></a></dt>
+    <dd>Specifies the name of a bytecode module to be created. A bytecode 
+    module can be specified in conjunction with other kinds of library builds 
+    or by itself. It constructs from the sources a single linked bytecode 
+    file.</dd>
     <dt><a name="OPTIONAL_DIRS"><tt>OPTIONAL_DIRS</tt></a></dt>
     <dd>Specify a set of directories that may be built, if they exist, but its
     not an error for them not to exist.</dd>
     all source files to be built twice: once with options for position
     independent code and once without. Use it only where you really need a
     shared library.</dd>
-    <dt><a name="SOURCES"><tt>SOURCES</tt><small>(optional)</small></a></td>
+    <dt><a name="SOURCES"><tt>SOURCES</tt><small>(optional)</small></a></dt>
     <dd>Specifies the list of source files in the current directory to be
     built. Source files of any type may be specified (programs, documentation, 
     config files, etc.). If not specified, the makefile system will infer the
     <dd>Specifies the name of the LLVM code generation target that the
     current directory builds. Setting this variable enables additional rules to
     build <tt>.inc</tt> files from <tt>.td</tt> files. </dd>
+    <dt><a name="TESTSUITE"><tt>TESTSUITE</tt></a></dt>
+    <dd>Specifies the directory of tests to run in <tt>llvm/test</tt>.</dd>
     <dt><a name="TOOLNAME"><tt>TOOLNAME</tt></a></dt>
     <dd>Specifies the name of the tool that the current directory should
     build.</dd>
-    <dt><a name="USEDLIBS"><tt>USEDLIBS</tt></a></td>
+    <dt><a name="TOOL_VERBOSE"><tt>TOOL_VERBOSE</tt></a></dt>
+    <dd>Implies VERBOSE and also tells each tool invoked to be verbose. This is
+    handy when you're trying to see the sub-tools invoked by each tool invoked 
+    by the makefile. For example, this will pass <tt>-v</tt> to the GCC 
+    compilers which causes it to print out the command lines it uses to invoke
+    sub-tools (compiler, assembler, linker).</dd>
+    <dt><a name="USEDLIBS"><tt>USEDLIBS</tt></a></dt>
     <dd>Specifies the list of project libraries that will be linked into the
     tool or library.</dd>
-    <dt><a name="VERBOSE"><tt>VERBOSE</tt></a></td>
+    <dt><a name="VERBOSE"><tt>VERBOSE</tt></a></dt>
     <dd>Tells the Makefile system to produce detailed output of what it is doing
     instead of just summary comments. This will generate a LOT of output.</dd>
   </dl>
     <li>On the <tt>make</tt> command line -- recommended.</li>
     <li>On the <tt>configure</tt> command line</li>
     <li>In the Makefile (only <em>after</em> the inclusion of <a
-    href="Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.</li>
+    href="#Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>).</li>
   </ul>
-  <p>The overridable variables are given below:</p>
+  <p>The override variables are given below:</p>
   <dl>
     <dt><a name="AR"><tt>AR</tt></a> <small>(defaulted)</small></dt>
     <dd>Specifies the path to the <tt>ar</tt> tool.</dd>
     <dt><a name="BISON"><tt>BISON</tt></a><small>(configured)</small></dt>
     <dd>Specifies the path to the <tt>bison</tt> tool.</dd>
-    <dt><a name="BUILD_OBJ_DIR"><tt>BUILD_OBJ_DIR</tt></a></dt>
+    <dt><a name="PROJ_OBJ_DIR"><tt>PROJ_OBJ_DIR</tt></a></dt>
     <dd>The directory into which the products of build rules will be placed.
     This might be the same as 
-    <a href="#BUILD_SRC_DIR"><tt>BUILD_SRC_DIR</tt></a> but typically is
+    <a href="#PROJ_SRC_DIR"><tt>PROJ_SRC_DIR</tt></a> but typically is
     not.</dd>
-    <dt><a name="BUILD_SRC_DIR"><tt>BUILD_SRC_DIR</tt></a></dt>
+    <dt><a name="PROJ_SRC_DIR"><tt>PROJ_SRC_DIR</tt></a></dt>
     <dd>The directory which contains the source files to be built.</dd>
     <dt><a name="BURG"><tt>BURG</tt></a></dt>
     <dd>Specifies the path to the <tt>burg</tt> tool.</dd>
     <dd>Specifies the path to the <tt>flex</tt> tool.</dd>
     <dt><a name="GCCLD"><tt>GCCLD</tt></a><small>(defaulted)</small></dt>
     <dd>Specifies the path to the <tt>gccld</tt> tool.</dd>
-    <dt><a name="HAVE_BZIP2"><tt>HAVE_BZIP2</tt></a><small>(configured)</small></dt>
-    <dd>This variable is set automatically if the <tt>configure</tt> script
-    could find the bzip2 library.</dd>
-    <dt><a name="HAVE_ZLIB"><tt>HAVE_ZLIB</tt></a><small>(configured)</small></dt>
-    <dd>This variable is set automatically if the <tt>configure</tt> script
-    could find the zlib library.</dd>
     <dt><a name="INSTALL"><tt>INSTALL</tt></a><small>(configured)</small></dt>
     <dd>Specifies the path to the <tt>install</tt> tool.</dd>
     <dt><a name="LDFLAGS"><tt>LDFLAGS</tt></a><small>(configured)</small></dt>
     <dd>The directory into which executables will ultimately be installed. This
     value is derived from the <tt>--prefix</tt> option given to
     <tt>configure</tt>.</dd>
+    <dt><a name="BuildMode"><tt>BuildMode</tt></a></dt>
+    <dd>The name of the type of build being performed: Debug, Release, or 
+    Profile</dd>
     <dt><a name="bytecode_libdir"><tt>bytecode_libdir</tt></a></dt>
     <dd>The directory into which bytecode libraries will ultimately be installed. 
     This value is derived from the <tt>--prefix</tt> option given to
     <dt><a name="Sources"><tt>Sources</tt></a></dt>
     <dd>The complete list of source files.</dd>
     <dt><a name="sysconfdir"><tt>sysconfdir</tt></a></dt>
-    <dd>The directory into which configuration files will ulitmately be
+    <dd>The directory into which configuration files will ultimately be
     installed. This value is derived from the <tt>--prefix</tt> option given to
     <tt>configure</tt>.</dd>
     <dt><a name="ToolDir"><tt>ToolDir</tt></a></dt>
     <dd>The configuration specific directory into which executables are placed
     before they are installed.</dd>
     <dt><a name="TopDistDir"><tt>TopDistDir</tt></a></dt>
-    <dd>The top most directory into which the distribution files are copied.</dd>
+    <dd>The top most directory into which the distribution files are copied.
+    </dd>
     <dt><a name="Verb"><tt>Verb</tt></a></dt>
     <dd>Use this as the first thing on your build script lines to enable or
     disable verbose mode. It expands to either an @ (quiet mode) or nothing
   <p>Variables listed below are used by the LLVM Makefile System 
   and considered internal. You should not use these variables under any
   circumstances.</p>
-  <dl>
-    <dt><a name="Archive"><tt>Archive</tt></a></dt><dd></dd>
-    <dt><a name="AR.Flags"><tt>AR.Flags</tt></a></dt><dd></dd>
-    <dt><a name="BaseNameSources"><tt>BaseNameSources</tt></a></dt><dd></dd>
-    <dt><a name="BCCompile.C"><tt>BCCompile.C</tt></a></dt><dd></dd>
-    <dt><a name="BCCompile.CXX"><tt>BCCompile.CXX</tt></a></dt><dd></dd>
-    <dt><a name="BCLinkLib"><tt>BCLinkLib</tt></a></dt><dd></dd>
-    <dt><a name="Burg"><tt>Burg</tt></a></dt><dd></dd>
-    <dt><a name="C.Flags"><tt>C.Flags</tt></a></dt><dd></dd>
-    <dt><a name="Compile.C"><tt>Compile.C</tt></a></dt><dd></dd>
-    <dt><a name="CompileCommonOpts"><tt>CompileCommonOpts</tt></a></dt><dd></dd>
-    <dt><a name="Compile.CXX"><tt>Compile.CXX</tt></a></dt><dd></dd>
-    <dt><a name="ConfigStatusScript"><tt>ConfigStatusScript</tt></a></dt><dd></dd>
-    <dt><a name="Configuration"><tt>Configuration</tt></a></dt><dd></dd>
-    <dt><a name="ConfigureScript"><tt>ConfigureScript</tt></a></dt><dd></dd>
-    <dt><a name="CPP.Flags"><tt>CPP.Flags</tt></a></dt><dd></dd>
-    <dt><a name="CPP.Flags "><tt>CPP.Flags </tt></a></dt><dd></dd>
-    <dt><a name="CXX.Flags"><tt>CXX.Flags</tt></a></dt><dd></dd>
-    <dt><a name="DependFiles"><tt>DependFiles</tt></a></dt><dd></dd>
-    <dt><a name="DestArchiveLib"><tt>DestArchiveLib</tt></a></dt><dd></dd>
-    <dt><a name="DestBytecodeLib"><tt>DestBytecodeLib</tt></a></dt><dd></dd>
-    <dt><a name="DestRelinkedLib"><tt>DestRelinkedLib</tt></a></dt><dd></dd>
-    <dt><a name="DestSharedLib"><tt>DestSharedLib</tt></a></dt><dd></dd>
-    <dt><a name="DestTool"><tt>DestTool</tt></a></dt><dd></dd>
-    <dt><a name="DistAlways"><tt>DistAlways</tt></a></dt><dd></dd>
-    <dt><a name="DistCheckDir"><tt>DistCheckDir</tt></a></dt><dd></dd>
-    <dt><a name="DistCheckTop"><tt>DistCheckTop</tt></a></dt><dd></dd>
-    <dt><a name="DistFiles"><tt>DistFiles</tt></a></dt><dd></dd>
-    <dt><a name="DistName"><tt>DistName</tt></a></dt><dd></dd>
-    <dt><a name="DistOther"><tt>DistOther</tt></a></dt><dd></dd>
-    <dt><a name="DistSources"><tt>DistSources</tt></a></dt><dd></dd>
-    <dt><a name="DistSubDirs"><tt>DistSubDirs</tt></a></dt><dd></dd>
-    <dt><a name="DistTarBZ2"><tt>DistTarBZ2</tt></a></dt><dd></dd>
-    <dt><a name="DistTarGZip"><tt>DistTarGZip</tt></a></dt><dd></dd>
-    <dt><a name="DistZip"><tt>DistZip</tt></a></dt><dd></dd>
-    <dt><a name="ExtraLibs"><tt>ExtraLibs</tt></a></dt><dd></dd>
-    <dt><a name="INCFiles"><tt>INCFiles</tt></a></dt><dd></dd>
-    <dt><a name="InternalTargets"><tt>InternalTargets</tt></a></dt><dd></dd>
-    <dt><a name="LD.Flags"><tt>LD.Flags</tt></a></dt><dd></dd>
-    <dt><a name="LexOutput"><tt>LexOutput</tt></a></dt><dd></dd>
-    <dt><a name="LibName.A"><tt>LibName.A</tt></a></dt><dd></dd>
-    <dt><a name="LibName.BC"><tt>LibName.BC</tt></a></dt><dd></dd>
-    <dt><a name="LibName.LA"><tt>LibName.LA</tt></a></dt><dd></dd>
-    <dt><a name="LibName.O"><tt>LibName.O</tt></a></dt><dd></dd>
-    <dt><a name="LibTool.Flags"><tt>LibTool.Flags</tt></a></dt><dd></dd>
-    <dt><a name="Link"><tt>Link</tt></a></dt><dd></dd>
-    <dt><a name="LLVMGCCLibDir"><tt>LLVMGCCLibDir</tt></a></dt><dd></dd>
-    <dt><a name="LLVMLibDir"><tt>LLVMLibDir</tt></a></dt><dd></dd>
-    <dt><a name="LLVMLibsOptions"><tt>LLVMLibsOptions</tt></a></dt><dd></dd>
-    <dt><a name="LLVMLibsPaths"><tt>LLVMLibsPaths</tt></a></dt><dd></dd>
-    <dt><a name="LLVMToolDir"><tt>LLVMToolDir</tt></a></dt><dd></dd>
-    <dt><a name="LLVMUsedLibs"><tt>LLVMUsedLibs</tt></a></dt><dd></dd>
-    <dt><a name="LocalTargets"><tt>LocalTargets</tt></a></dt><dd></dd>
-    <dt><a name="LTCompile.C"><tt>LTCompile.C</tt></a></dt><dd></dd>
-    <dt><a name="LTCompile.CXX"><tt>LTCompile.CXX</tt></a></dt><dd></dd>
-    <dt><a name="LTInstall"><tt>LTInstall</tt></a></dt><dd></dd>
-    <dt><a name="ObjectsBC"><tt>ObjectsBC</tt></a></dt><dd></dd>
-    <dt><a name="ObjectsLO"><tt>ObjectsLO</tt></a></dt><dd></dd>
-    <dt><a name="ObjectsO"><tt>ObjectsO</tt></a></dt><dd></dd>
-    <dt><a name="ObjMakefiles"><tt>ObjMakefiles</tt></a></dt><dd></dd>
-    <dt><a name="Parallel_Targets"><tt>Parallel_Targets</tt></a></dt><dd></dd>
-    <dt><a name="PreConditions"><tt>PreConditions</tt></a></dt><dd></dd>
-    <dt><a name="ProjLibsOptions"><tt>ProjLibsOptions</tt></a></dt><dd></dd>
-    <dt><a name="ProjLibsPaths"><tt>ProjLibsPaths</tt></a></dt><dd></dd>
-    <dt><a name="ProjUsedLibs"><tt>ProjUsedLibs</tt></a></dt><dd></dd>
-    <dt><a name="Ranlib"><tt>Ranlib</tt></a></dt><dd></dd>
-    <dt><a name="RecursiveTargets"><tt>RecursiveTargets</tt></a></dt><dd></dd>
-    <dt><a name="Relink"><tt>Relink</tt></a></dt><dd></dd>
-    <dt><a name="SrcMakefiles"><tt>SrcMakefiles</tt></a></dt><dd></dd>
-    <dt><a name="Strip"><tt>Strip</tt></a></dt><dd></dd>
-    <dt><a name="StripWarnMsg"><tt>StripWarnMsg</tt></a></dt><dd></dd>
-    <dt><a name="TableGen"><tt>TableGen</tt></a></dt><dd></dd>
-    <dt><a name="TDFiles"><tt>TDFiles</tt></a></dt><dd></dd>
-    <dt><a name="ToolBuildPath"><tt>ToolBuildPath</tt></a></dt><dd></dd>
-    <dt><a name="TopLevelTargets"><tt>TopLevelTargets</tt></a></dt><dd></dd>
-    <dt><a name="UserTargets"><tt>UserTargets</tt></a></dt><dd></dd>
-    <dt><a name="YaccOutput"><tt>YaccOutput</tt></a></dt><dd></dd>
-  </dl>
+  <p><tt>
+    Archive
+    AR.Flags
+    BaseNameSources
+    BCCompile.C
+    BCCompile.CXX
+    BCLinkLib
+    Burg
+    C.Flags
+    Compile.C
+    CompileCommonOpts
+    Compile.CXX
+    ConfigStatusScript
+    ConfigureScript
+    CPP.Flags
+    CPP.Flags 
+    CXX.Flags
+    DependFiles
+    DestArchiveLib
+    DestBytecodeLib
+    DestModule
+    DestRelinkedLib
+    DestSharedLib
+    DestTool
+    DistAlways
+    DistCheckDir
+    DistCheckTop
+    DistFiles
+    DistName
+    DistOther
+    DistSources
+    DistSubDirs
+    DistTarBZ2
+    DistTarGZip
+    DistZip
+    ExtraLibs
+    FakeSources
+    INCFiles
+    InternalTargets
+    LD.Flags
+    LexFiles
+    LexOutput
+    LibName.A
+    LibName.BC
+    LibName.LA
+    LibName.O
+    LibTool.Flags
+    Link
+    LinkModule
+    LLVMLibDir
+    LLVMLibsOptions
+    LLVMLibsPaths
+    LLVMToolDir
+    LLVMUsedLibs
+    LocalTargets
+    LTCompile.C
+    LTCompile.CXX
+    LTInstall
+    Module
+    ObjectsBC
+    ObjectsLO
+    ObjectsO
+    ObjMakefiles
+    ParallelTargets
+    PreConditions
+    ProjLibsOptions
+    ProjLibsPaths
+    ProjUsedLibs
+    Ranlib
+    RecursiveTargets
+    Relink
+    SrcMakefiles
+    Strip
+    StripWarnMsg
+    TableGen
+    TDFiles
+    ToolBuildPath
+    TopLevelTargets
+    UserTargets
+    YaccFiles
+    YaccOutput
+  </tt></p>
 </div>
 
 <!-- *********************************************************************** -->