docs/MakefileGuide.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   5   <title>LLVM Makefile Guide</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">LLVM Makefile Guide</div>
  11
  12 <ol>
  13   <li><a href="#introduction">Introduction</a></li>
  14   <li><a href="#general">General Concepts</a>
  15     <ol>
  16       <li><a href="#projects">Projects</a></li>
  17       <li><a href="#varvals">Variable Values</a></li>
  18       <li><a href="#including">Including Makefiles</a>
  19         <ol>
  20           <li><a href="#Makefile">Makefile</a></li>
  21           <li><a href="#Makefile.common">Makefile.common</a></li>
  22           <li><a href="#Makefile.config">Makefile.config</a></li>
  23           <li><a href="#Makefile.rules">Makefile.rules</a></li>
  24         </ol>
  25       </li>
  26       <li><a href="#Comments">Comments</a></li>
  27     </ol>
  28   </li>
  29   <li><a href="#tutorial">Tutorial</a>
  30     <ol>
  31       <li><a href="#libraries">Libraries</a>
  32         <ol>
  33           <li><a href="#Modules">Bytecode Modules</a></li>
  34         </ol>
  35       </li>
  36       <li><a href="#tools">Tools</a>
  37         <ol>
  38           <li><a href="#JIT">JIT Tools</a></li>
  39         </ol>
  40       </li>
  41       <li><a href="#projects">Projects</a></li>
  42     </ol>
  43   </li>
  44   <li><a href="#targets">Targets Supported</a>
  45     <ol>
  46       <li><a href="#all">all</a></li>
  47       <li><a href="#all-local">all-local</a></li>
  48       <li><a href="#check">check</a></li>
  49       <li><a href="#check-local">check-local</a></li>
  50       <li><a href="#clean">clean</a></li>
  51       <li><a href="#clean-local">clean-local</a></li>
  52       <li><a href="#dist">dist</a></li>
  53       <li><a href="#dist-check">dist-check</a></li>
  54       <li><a href="#dist-clean">dist-clean</a></li>
  55       <li><a href="#install">install</a></li>
  56       <li><a href="#preconditions">preconditions</a></li>
  57       <li><a href="#printvars">printvars</a></li>
  58       <li><a href="#reconfigure">reconfigure</a></li>
  59       <li><a href="#spotless">spotless</a></li>
  60       <li><a href="#tags">tags</a></li>
  61       <li><a href="#uninstall">uninstall</a></li>
  62     </ol>
  63   </li>
  64   <li><a href="#variables">Using Variables</a>
  65     <ol>
  66       <li><a href="#setvars">Control Variables</a></li>
  67       <li><a href="#overvars">Override Variables</a></li>
  68       <li><a href="#getvars">Readable Variables</a></li>
  69       <li><a href="#intvars">Internal Variables</a></li>
  70     </ol>
  71   </li>
  72 </ol>
  73
  74 <div class="doc_author">
  75   <p>Written by <a href="mailto:reid@x10sys.com">Reid Spencer</a></p>
  76 </div>
  77
  78 <!-- *********************************************************************** -->
  79 <div class="doc_section"><a name="introduction">Introduction </a></div>
  80 <!-- *********************************************************************** -->
  81
  82 <div class="doc_text">
  83   <p>This document provides <em>usage</em> information about the LLVM makefile
  84   system. While loosely patterned after the BSD makefile system, LLVM has taken
  85   a departure from BSD in order to implement additional features needed by LLVM.
  86   Although makefile systems such as automake were attempted at one point, it
  87   has become clear that the features needed by LLVM and the Makefile norm are
  88   too great to use a more limited tool. Consequently, LLVM requires simply GNU
  89   Make 3.79, a widely portable makefile processor. LLVM unabashedly makes heavy
  90   use of the features of GNU Make so the dependency on GNU Make is firm. If
  91   you're not familiar with <tt>make</tt>, it is recommended that you read the
  92   <a href="http://www.gnu.org/software/make/manual/make.html">GNU Makefile
  93   Manual</a>.</p>
  94   <p>While this document is rightly part of the
  95   <a href="ProgrammersManual.html">LLVM Programmer's Manual</a>, it is treated
  96   separately here because of the volume of content and because it is often an
  97   early source of bewilderment for new developers.</p>
  98 </div>
  99
 100 <!-- *********************************************************************** -->
 101 <div class="doc_section"><a name="general">General Concepts</a></div>
 102 <!-- *********************************************************************** -->
 103
 104 <div class="doc_text">
 105   <p>The LLVM Makefile System is the component of LLVM that is responsible for
 106   building the software, testing it,  generating distributions, checking those
 107   distributions, installing and uninstalling, etc. It consists of a several
 108   files throughout the source tree. These files and other general concepts are
 109   described in this section.</p>
 110 </div>
 111
 112 <!-- ======================================================================= -->
 113 <div class="doc_subsection"><a name="projects">Projects</a></div>
 114 <div class="doc_text">
 115   <p>The LLVM Makefile System is quite generous. It not only builds its own
 116   software, but it can build yours too. Built into the system is knowledge of
 117   the <tt>llvm/projects</tt> directory. Any directory under <tt>projects</tt>
 118   that has both a <tt>configure</tt> script and a <tt>Makefile</tt> is assumed
 119   to be a project that uses the LLVM Makefile system.  Building software that
 120   uses LLVM does not require the LLVM Makefile System nor even placement in the
 121   <tt>llvm/projects</tt> directory. However, doing so will allow your project
 122   to get up and running quickly by utilizing the built-in features that are used
 123   to compile LLVM. LLVM compiles itself using the same features of the makefile
 124   system as used for projects.</p>
 125   <p>For complete details on setting up your projects configuration, simply
 126   mimic the <tt>llvm/projects/sample</tt> project or for further details,
 127   consult the <a href="Projects.html">Projects.html</a> page.</p>
 128 </div>
 129
 130 <!-- ======================================================================= -->
 131 <div class="doc_subsection"><a name="varvalues">Variable Values</a></div>
 132 <div class="doc_text">
 133   <p>To use the makefile system, you simply create a file named
 134   <tt>Makefile</tt> in your directory and declare values for certain variables.
 135   The variables and values that you select determine what the makefile system
 136   will do. These variables enable rules and processing in the makefile system
 137   that automatically Do The Right Thing&trade;.
 138 </div>
 139
 140 <!-- ======================================================================= -->
 141 <div class="doc_subsection"><a name="including">Including Makefiles</a></div>
 142 <div class="doc_text">
 143   <p>Setting variables alone is not enough. You must include into your Makefile
 144   additional files that provide the rules of the LLVM Makefile system. The
 145   various files involved are described in the sections that follow.</p>
 146 </div>
 147
 148 <!-- ======================================================================= -->
 149 <div class="doc_subsubsection"><a name="Makefile">Makefile</a></div>
 150 <div class="doc_text">
 151   <p>Each directory to participate in the build needs to have a file named
 152   <tt>Makefile</tt>. This is the file first read by <tt>make</tt>. It has three
 153   sections:</p>
 154   <ol>
 155     <li><a href="#setvars">Settable Variables</a> - Required that must be set
 156     first.</li>
 157     <li><a href="#Makefile.common">include <tt>$(LEVEL)/Makefile.common</tt></a>
 158     - include the LLVM Makefile system.
 159     <li><a href="#overvars">Override Variables</a> - Override variables set by
 160     the LLVM Makefile system.
 161   </ol>
 162 </div>
 163
 164 <!-- ======================================================================= -->
 165 <div class="doc_subsubsection"><a name="Makefile.common">Makefile.common</a>
 166 </div>
 167 <div class="doc_text">
 168   <p>Every project must have a <tt>Makefile.common</tt> file at its top source
 169   directory. This file serves three purposes:</p>
 170   <ol>
 171     <li>It includes the project's configuration makefile to obtain values
 172     determined by the <tt>configure</tt> script. This is done by including the
 173     <a href="#Makefile.config"><tt>$(LEVEL)/Makefile.config</tt></a> file.</li>
 174     <li>It specifies any other (static) values that are needed throughout the
 175     project. Only values that are used in all or a large proportion of the
 176     project's directories should be placed here.</li>
 177     <li>It includes the standard rules for the LLVM Makefile system,
 178     <a href="#Makefile.rules"><tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt></a>.
 179     This file is the "guts" of the LLVM Makefile system.</li>
 180   </ol>
 181 </div>
 182
 183 <!-- ======================================================================= -->
 184 <div class="doc_subsubsection"><a name="Makefile.config">Makefile.config</a>
 185 </div>
 186 <div class="doc_text">
 187   <p>Every project must have a <tt>Makefile.config</tt> at the top of its
 188   <em>build</em> directory. This file is <b>generated</b> by the
 189   <tt>configure</tt> script from the pattern provided by the
 190   <tt>Makefile.config.in</tt> file located at the top of the project's
 191   <em>source</em> directory. The contents of this file depend largely on what
 192   configuration items the project uses, however most projects can get what they
 193   need by just relying on LLVM's configuration found in
 194   <tt>$(LLVM_OBJ_ROOT)/Makefile.config</tt>.
 195 </div>
 196
 197 <!-- ======================================================================= -->
 198 <div class="doc_subsubsection"><a name="Makefile.rules">Makefile.rules</a></div>
 199 <div class="doc_text">
 200   <p>This file, located at <tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt> is the heart
 201   of the LLVM Makefile System. It provides all the logic, dependencies, and
 202   rules for building the targets supported by the system. What it does largely
 203   depends on the values of <tt>make</tt> <a href="#variables">variables</a> that
 204   have been set <em>before</em> <tt>Makefile.rules</tt> is included.
 205 </div>
 206
 207 <!-- ======================================================================= -->
 208 <div class="doc_subsection"><a name="Comments">Comments</a></div>
 209 <div class="doc_text">
 210   <p>User Makefiles need not have comments in them unless the construction is
 211   unusual or it does not strictly follow the rules and patterns of the LLVM
 212   makefile system. Makefile comments are invoked with the pound (#) character.
 213   The # character and any text following it, to the end of the line, are ignored
 214   by <tt>make</tt>.</p>
 215 </div>
 216
 217 <!-- *********************************************************************** -->
 218 <div class="doc_section"><a name="tutorial">Tutorial</a></div>
 219 <!-- *********************************************************************** -->
 220 <div class="doc_text">
 221   <p>This section provides some examples of the different kinds of modules you
 222   can build with the LLVM makefile system. In general, each directory you
 223   provide will build a single object although that object may be composed of
 224   additionally compiled components.</p>
 225 </div>
 226
 227 <!-- ======================================================================= -->
 228 <div class="doc_subsection"><a name="libraries">Libraries</a></div>
 229 <div class="doc_text">
 230   <p>Only a few variable definitions are needed to build a regular library.
 231   Normally, the makefile system will build all the software into a single
 232   <tt>libname.o</tt> (pre-linked) object. This means the library is not
 233   searchable and that the distinction between compilation units has been
 234   dissolved. Optionally, you can ask for a shared library (.so), archive library
 235   (.a) or to not have the default (relinked) library built. For example:</p>
 236   <pre><tt>
 237       LIBRARYNAME = mylib
 238       SHARED_LIBRARY = 1
 239       ARCHIVE_LIBRARY = 1
 240       DONT_BUILT_RELINKED = 1
 241   </tt></pre>
 242   <p>says to build a library named "mylib" with both a shared library
 243   (<tt>mylib.so</tt>) and an archive library (<tt>mylib.a</tt>) version but
 244   not to build the relinked object (<tt>mylib.o</tt>). The contents of all the
 245   libraries produced will be the same, they are just constructed differently.
 246   Note that you normally do not need to specify the sources involved. The LLVM
 247   Makefile system will infer the source files from the contents of the source
 248   directory.</p>
 249   <p>The <tt>LOADABLE_MODULE=1</tt> directive can be used in conjunction with
 250   <tt>SHARED_LIBRARY=1</tt> to indicate that the resulting shared library should
 251   be openable with the <tt>dlopen</tt> function and searchable with the
 252   <tt>dlsym</tt> function (or your operating system's equivalents). While this
 253   isn't strictly necessary on Linux and a few other platforms, it is required
 254   on systems like HP-UX and Darwin. You should use <tt>LOADABLE_MODULE</tt> for
 255   any shared library that you intend to be loaded into an tool via the
 256   <tt>-load</tt> option. See the
 257   <a href="WritingAnLLVMPass.html#makefile">WritingAnLLVMPass.html</a> document
 258   for an example of why you might want to do this.
 259 </div>
 260
 261 <!-- ======================================================================= -->
 262 <div class="doc_subsubsection"><a name="Modules">Bytecode Modules</a></div>
 263 <div class="doc_text">
 264   <p>In some situations, it is desireable to build a single bytecode module from
 265   a variety of sources, instead of an archive, shared library, or bytecode
 266   library. Bytecode modules can be specified in addition to any of the other
 267   types of libraries by defining the <a href="#MODULE_NAME">MODULE_NAME</a>
 268   variable. For example:</p>
 269   <pre><tt>
 270       LIBRARYNAME = mylib
 271       BYTECODE_LIBRARY = 1
 272       MODULE_NAME = mymod
 273   </tt></pre>
 274   <p>will build a module named <tt>mymod.bc</tt> from the sources in the
 275   directory. This module will be an aggregation of all the bytecode modules
 276   derived from the sources. The example will also build a bytecode archive
 277   containing a bytecode module for each compiled source file. The difference is
 278   subtle, but important depending on how the module or library is to be linked.
 279   </p>
 280 </div>
 281
 282 <!-- ======================================================================= -->
 283 <div class="doc_subsection"><a name="tools">Tools</a></div>
 284 <div class="doc_text">
 285   <p>For building executable programs (tools), you must provide the name of the
 286   tool and the names of the libraries you wish to link with the tool. For
 287   example:</p>
 288   <pre><tt>
 289       TOOLNAME = mytool
 290       USEDLIBS = mylib
 291       LLVMLIBS = LLVMSupport.a LLVMSystem.a
 292   </tt></pre>
 293   <p>says that we are to build a tool name <tt>mytool</tt> and that it requires
 294   three libraries: <tt>mylib</tt>, <tt>LLVMSupport.a</tt> and
 295   <tt>LLVMSystem.a</tt>.</p>
 296   <p>Note that two different variables are use to indicate which libraries are
 297   linked: <tt>USEDLIBS</tt> and <tt>LLVMLIBS</tt>. This distinction is necessary
 298   to support projects. <tt>LLVMLIBS</tt> refers to the LLVM libraries found in
 299   the LLVM object directory. <tt>USEDLIBS</tt> refers to the libraries built by
 300   your project. In the case of building LLVM tools, <tt>USEDLIBS</tt> and
 301   <tt>LLVMLIBS</tt> can be used interchangeably since the "project" is LLVM
 302   itself and <tt>USEDLIBS</tt> refers to the same place as <tt>LLVMLIBS</tt>.
 303   </p>
 304   <p>Also note that there are two different ways of specifying a library: with a
 305   <tt>.a</tt> suffix and without. Without the suffix, the entry refers to the
 306   re-linked (.o) file which will include <em>all</em> symbols of the library.
 307   This is useful, for example, to include all passes from a library of passes.
 308   If the <tt>.a</tt> suffix is used then the library is linked as a searchable
 309   library (with the <tt>-l</tt> option). In this case, only the symbols that are
 310   unresolved <em>at that point</em> will be resolved from the library, if they
 311   exist. Other (unreferenced) symbols will not be included when the <tt>.a</tt>
 312   syntax is used. Note that in order to use the <tt>.a</tt> suffix, the library
 313   in question must have been built with the <tt>ARCHIVE_LIBRARY</tt> option set.
 314   </p>
 315 </div>
 316
 317 <!-- ======================================================================= -->
 318 <div class="doc_subsubsection"><a name="JIT">JIT Tools</a></div>
 319 <div class="doc_text">
 320   <p>Many tools will want to use the JIT features of LLVM. However, getting the
 321   right set of libraries to link with is tedious, platform specific, and error
 322   prone. Additionally, the JIT has special linker switch options that it needs.
 323   Consequently, to make it easier to build tools that use the JIT, you can
 324   use a special value for the <tt>LLVMLIBS</tt> variable:</p>
 325   <pre><tt>
 326       TOOLNAME = my_jit_tool
 327       USEDLIBS = mylib
 328       LLVMLIBS = JIT
 329   </tt></pre>
 330   <p>Using a value of <tt>JIT</tt> for <tt>LLVMLIBS</tt> tells the makefile
 331   system to construct a special value for LLVMLIBS that gives the program all
 332   the LLVM libraries needed to run the JIT. Any additional libraries needed can
 333   still be specified with <tt>USEDLIBS</tt>. To get a full understanding of how
 334   this changes the linker command, it is recommended that you:</p>
 335   <pre><tt>
 336       cd examples/Fibonacci
 337       make VERBOSE=1
 338   </tt></pre>
 339   <p>By default, using <tt>LLVMLIBS=JIT</tt> will link in enough to support JIT
 340   code generation for the architecture on which the tool is linked. If you need
 341   additional target architectures linked in, you may specify them on the command
 342   line or in your <tt>Makefile</tt>. For example:</p>
 343   <pre><tt>
 344       ENABLE_X86_JIT=1
 345       ENABLE_SPARCV9_JIT=1
 346       ENALBE_PPC_JIT=1
 347   </tt></pre>
 348   <p>will cause the tool to be able to generate code for all three platforms.
 349   </p>
 350 </div>
 351
 352 <!-- *********************************************************************** -->
 353 <div class="doc_section"><a name="targets">Targets Supported</a></div>
 354 <!-- *********************************************************************** -->
 355
 356 <div class="doc_text">
 357   <p>This section describes each of the targets that can be built using the LLVM
 358   Makefile system. Any target can be invoked from any directory but not all are
 359   applicable to a given directory (e.g. "check", "dist" and "install" will
 360   always operate as if invoked from the top level directory).</p>
 361
 362   <table style="text-align:left">
 363     <tr>
 364       <th>Target Name</th><th>Implied Targets</th><th>Target Description</th>
 365     </tr>
 366     <tr><td><a href="#all"><tt>all</tt></a></td><td></td>
 367       <td>Compile the software recursively. Default target.
 368     </td></tr>
 369     <tr><td><a href="#all-local"><tt>all-local</tt></a></td><td></td>
 370       <td>Compile the software in the local directory only.
 371     </td></tr>
 372     <tr><td><a href="#check"><tt>check</tt></a></td><td></td>
 373       <td>Change to the <tt>test</tt> directory in a project and run the
 374       test suite there.
 375     </td></tr>
 376     <tr><td><a href="#check-local"><tt>check-local</tt></a></td><td></td>
 377       <td>Run a local test suite. Generally this is only defined in the
 378         <tt>Makefile</tt> of the project's <tt>test</tt> directory.
 379     </td></tr>
 380     <tr><td><a href="#clean"><tt>clean</tt></a></td><td></td>
 381       <td>Remove built objects recursively.
 382     </td></tr>
 383     <tr><td><a href="#clean-local"><tt>clean-local</tt></a></td><td></td>
 384       <td>Remove built objects from the local directory only.
 385     </td></tr>
 386     <tr><td><a href="#dist"><tt>dist</tt></a></td><td>all</td>
 387       <td>Prepare a source distribution tarball.
 388     </td></tr>
 389     <tr><td><a href="#dist-check"><tt>dist-check</tt></a></td><td>all</td>
 390       <td>Prepare a source distribution tarball and check that it builds.
 391     </td></tr>
 392     <tr><td><a href="#dist-clean"><tt>dist-clean</tt></a></td><td>clean</td>
 393       <td>Clean source distribution tarball temporary files.
 394     </td></tr>
 395     <tr><td><a href="#install"><tt>install</tt></a></td><td>all</td>
 396       <td>Copy built objects to installation directory.
 397     </td></tr>
 398     <tr><td><a href="#preconditions"><tt>preconditions</tt></a></td><td>all</td>
 399       <td>Check to make sure configuration and makefiles are up to date.
 400     </td></tr>
 401     <tr><td><a href="#printvars"><tt>printvars</tt></a></td><td>all</td>
 402       <td>Prints variables defined by the makefile system (for debugging).
 403     </td></tr>
 404     <tr><td><a href="#tags"><tt>tags</tt></a></td><td></td>
 405       <td>Make C and C++ tags files for emacs and vi.
 406     </td></tr>
 407     <tr><td><a href="#uninstall"><tt>uninstall</tt></a></td><td></td>
 408       <td>Remove built objects from installation directory.
 409     </td></tr>
 410   </table>
 411 </div>
 412
 413 <!-- ======================================================================= -->
 414 <div class="doc_subsection"><a name="all">all (default)</a></div>
 415 <div class="doc_text">
 416   <p>When you invoke <tt>make</tt> with no arguments, you are implicitly
 417   instructing it to seek the "all" target (goal). This target is used for
 418   building the software recursively and will do different things in different
 419   directories.  For example, in a <tt>lib</tt> directory, the "all" target will
 420   compile source files and generate libraries. But, in a <tt>tools</tt>
 421   directory, it will link libraries and generate executables.</p>
 422 </div>
 423
 424 <!-- ======================================================================= -->
 425 <div class="doc_subsection"><a name="all-local">all-local</a></div>
 426 <div class="doc_text">
 427   <p>This target is the same as <a href="#all">all</a> but it operates only on
 428   the current directory instead of recursively.</p>
 429 </div>
 430
 431 <!-- ======================================================================= -->
 432 <div class="doc_subsection"><a name="check">check</a></div>
 433 <div class="doc_text">
 434   <p>This target can be invoked from anywhere within a project's directories
 435   but always invokes the <a href="#check-local"><tt>check-local</tt></a> target
 436   in the project's <tt>test</tt> directory, if it exists and has a
 437   <tt>Makefile</tt>. A warning is produced otherwise.  If
 438   <a href="#TESTSUITE"><tt>TESTSUITE</tt></a> is defined on the <tt>make</tt>
 439   command line, it will be passed down to the invocation of
 440   <tt>make check-local</tt> in the <tt>test</tt> directory. The intended usage
 441   for this is to assist in running specific suites of tests. If
 442   <tt>TESTSUITE</tt> is not set, the implementation of <tt>check-local</tt>
 443   should run all normal tests.  It is up to the project to define what
 444   different values for <tt>TESTSUTE</tt> will do. See the
 445   <a href="TestingGuide.html">TestingGuide</a> for further details.</p>
 446 </div>
 447
 448 <!-- ======================================================================= -->
 449 <div class="doc_subsection"><a name="check-local">check-local</a></div>
 450 <div class="doc_text">
 451   <p>This target should be implemented by the <tt>Makefile</tt> in the project's
 452   <tt>test</tt> directory. It is invoked by the <tt>check</tt> target elsewhere.
 453   Each project is free to define the actions of <tt>check-local</tt> as
 454   appropriate for that project. The LLVM project itself uses dejagnu to run a
 455   suite of feature and regresson tests. Other projects may choose to use
 456   dejagnu or any other testing mechanism.</p>
 457 </div>
 458
 459 <!-- ======================================================================= -->
 460 <div class="doc_subsection"><a name="clean">clean</a></div>
 461 <div class="doc_text">
 462   <p>This target cleans the build directory, recursively removing all things
 463   that the Makefile builds. The cleaning rules have been made guarded so they
 464   shouldn't go awry (via <tt>rm -f $(UNSET_VARIABLE)/*</tt> which will attempt
 465   to erase the entire directory structure.</p>
 466 </div>
 467
 468 <!-- ======================================================================= -->
 469 <div class="doc_subsection"><a name="clean-local">clean-local</a></div>
 470 <div class="doc_text">
 471   <p>This target does the same thing as <tt>clean</tt> but only for the current
 472   (local) directory.</p>
 473 </div>
 474
 475 <!-- ======================================================================= -->
 476 <div class="doc_subsection"><a name="dist">dist</a></div>
 477 <div class="doc_text">
 478   <p>This target builds a distribution tarball. It first builds the entire
 479   project using the <tt>all</tt> target and then tars up the necessary files and
 480   compresses it. The generated tarball is sufficient for a casual source
 481   distribution, but probably not for a release (see <tt>dist-check</tt>).</p>
 482 </div>
 483
 484 <!-- ======================================================================= -->
 485 <div class="doc_subsection"><a name="dist-check">dist-check</a></div>
 486 <div class="doc_text">
 487   <p>This target does the same thing as the <tt>dist</tt> target but also checks
 488   the distribution tarball. The check is made by unpacking the tarball to a new
 489   directory, configuring it, building it, installing it, and then verifying that
 490   the installation results are correct (by comparing to the original build).
 491   This target can take a long time to run but should be done before a release
 492   goes out to make sure that the distributed tarball can actually be built into
 493   a working release.</p>
 494 </div>
 495
 496 <!-- ======================================================================= -->
 497 <div class="doc_subsection"><a name="dist-clean">dist-clean</a></div>
 498 <div class="doc_text">
 499   <p>This is a special form of the <tt>clean</tt> clean target. It performs a
 500   normal <tt>clean</tt> but also removes things pertaining to building the
 501   distribution.</p>
 502 </div>
 503
 504 <!-- ======================================================================= -->
 505 <div class="doc_subsection"><a name="install">install</a></div>
 506 <div class="doc_text">
 507   <p>This target finalizes shared objects and executables and copies all
 508   libraries, headers, executables and documentation to the directory given
 509   with the <tt>--prefix</tt> option to <tt>configure</tt>.  When completed,
 510   the prefix directory will have everything needed to <b>use</b> LLVM. </p>
 511   <p>The LLVM makefiles can generate complete <b>internal</b> documentation
 512   for all the classes by using <tt>doxygen</tt>. By default, this feature is
 513   <b>not</b> enabled because it takes a long time and generates a massive
 514   amount of data (>100MB). If you want this feature, you must configure LLVM
 515   with the --enable-doxygen switch and ensure that a modern version of doxygen
 516   (1.3.7 or later) is available in your <tt>PATH</tt>. You can download
 517   doxygen from
 518   <a href="http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc">
 519   here</a>.
 520 </div>
 521
 522 <!-- ======================================================================= -->
 523 <div class="doc_subsection"><a name="preconditions">preconditions</a></div>
 524 <div class="doc_text">
 525   <p>This utility target checks to see if the <tt>Makefile</tt> in the object
 526   directory is older than the <tt>Makefile</tt> in the source directory and
 527   copies it if so. It also reruns the <tt>configure</tt> script if that needs to
 528   be done and rebuilds the <tt>Makefile.config</tt> file similarly. Users may
 529   overload this target to ensure that sanity checks are run <em>before</em> any
 530   building of targets as all the targets depend on <tt>preconditions</tt>.</p>
 531 </div>
 532
 533 <!-- ======================================================================= -->
 534 <div class="doc_subsection"><a name="printvars">printvars</a></div>
 535 <div class="doc_text">
 536   <p>This utility target just causes the LLVM makefiles to print out some of
 537   the makefile variables so that you can double check how things are set. </p>
 538 </div>
 539
 540 <!-- ======================================================================= -->
 541 <div class="doc_subsection"><a name="reconfigure">reconfigure</a></div>
 542 <div class="doc_text">
 543   <p>This utility target will force a reconfigure of LLVM or your project. It
 544   simply runs <tt>$(PROJ_OBJ_ROOT)/config.status --recheck</tt> to rerun the
 545   configuration tests and rebuild the configured files. This isn't generally
 546   useful as the makefiles will reconfigure themselves whenever its necessary.
 547   </p>
 548 </div>
 549
 550 <!-- ======================================================================= -->
 551 <div class="doc_subsection"><a name="spotless">spotless</a></div>
 552 <div class="doc_text">
 553   <p>This utility target, only available when <tt>$(PROJ_OBJ_ROOT)</tt> is not
 554   the same as <tt>$(PROJ_SRC_ROOT)</tt>, will completely clean the
 555   <tt>$(PROJ_OBJ_ROOT)</tt> directory by removing its content entirely and
 556   reconfiguring the directory. This returns the <tt>$(PROJ_OBJ_ROOT)</tt>
 557   directory to a completely fresh state. All content in the directory except
 558   configured files and top-level makefiles will be lost.</p>
 559   <div class="doc_warning"><p>Use with caution.</p></div>
 560 </div>
 561
 562 <!-- ======================================================================= -->
 563 <div class="doc_subsection"><a name="tags">tags</a></div>
 564 <div class="doc_text">
 565   <p>This target will generate a <tt>TAGS</tt> file in the top-level source
 566   directory. It is meant for use with emacs, XEmacs, or ViM. The TAGS file
 567   provides an index of symbol definitions so that the editor can jump you to the
 568   definition quickly. </p>
 569 </div>
 570
 571 <!-- ======================================================================= -->
 572 <div class="doc_subsection"><a name="uninstall">uninstall</a></div>
 573 <div class="doc_text">
 574   <p>This target is the opposite of the <tt>install</tt> target. It removes the
 575   header, library and executable files from the installation directories. Note
 576   that the directories themselves are not removed because it is not guaranteed
 577   that LLVM is the only thing installing there (e.g. --prefix=/usr).</p>
 578 </div>
 579
 580 <!-- *********************************************************************** -->
 581 <div class="doc_section"><a name="variables">Variables</a></div>
 582 <!-- *********************************************************************** -->
 583 <div class="doc_text">
 584   <p>Variables are used to tell the LLVM Makefile System what to do and to
 585   obtain information from it. Variables are also used internally by the LLVM
 586   Makefile System. Variable names that contain only the upper case alphabetic
 587   letters and underscore are intended for use by the end user. All other
 588   variables are internal to the LLVM Makefile System and should not be relied
 589   upon nor modified. The sections below describe how to use the LLVM Makefile
 590   variables.</p>
 591 </div>
 592
 593 <!-- ======================================================================= -->
 594 <div class="doc_subsection"><a name="setvars">Control Variables</a></div>
 595 <div class="doc_text">
 596   <p>Variables listed in the table below should be set <em>before</em> the
 597   inclusion of <a href="#Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.
 598   These variables provide input to the LLVM make system that tell it what to do
 599   for the current directory.</p>
 600   <dl>
 601     <dt><a name="BUILD_ARCHIVE"><tt>BUILD_ARCHIVE</tt></a></dt>
 602     <dd>If set to any value, causes an archive (.a) library to be built.</dd>
 603     <dt><a name="BUILT_SOURCES"><tt>BUILT_SOURCES</tt></a></dt>
 604     <dd>Specifies a set of source files that are generated from other source
 605     files. These sources will be built before any other target processing to
 606     ensure they are present.</dd>
 607     <dt><a name="BYTECODE_LIBRARY"><tt>BYTECODE_LIBRARY</tt></a></dt>
 608     <dd>If set to any value, causes a bytecode library (.bc) to be built.</dd>
 609     <dt><a name="CONFIG_FILES"><tt>CONFIG_FILES</tt></a></dt>
 610     <dd>Specifies a set of configuration files to be installed.</dd>
 611     <dt><a name="DIRS"><tt>DIRS</tt></a></dt>
 612     <dd>Specifies a set of directories, usually children of the current
 613     directory, that should also be made using the same goal. These directories
 614     will be built serially.</dd>
 615     <dt><a name="DISABLE_AUTO_DEPENDENCIES"><tt>DISABLE_AUTO_DEPENDENCIES</tt></a></dt>
 616     <dd>If set to any value, causes the makefiles to <b>not</b> automatically
 617     generate dependencies when running the compiler. Use of this feature is
 618     discouraged and it may be removed at a later date.</dd>
 619     <dt><a name="DONT_BUILD_RELINKED"><tt>DONT_BUILD_RELINKED</tt></a></dt>
 620     <dd>If set to any value, causes a relinked library (.o) not to be built. By
 621     default, libraries are built as re-linked since most LLVM libraries are
 622     needed in their entirety and re-linked libraries will be linked more quickly
 623     than equivalent archive libraries.</dd>
 624     <dt><a name="ENABLE_OPTIMIZED"><tt>ENABLE_OPTIMIZED</tt></a></dt>
 625     <dd>If set to any value, causes the build to generate optimized objects,
 626     libraries and executables. This alters the flags specified to the compilers
 627     and linkers. Generally debugging won't be a fun experience with an optimized
 628     build.</dd>
 629     <dt><a name="ENABLE_PROFILING"><tt>ENABLE_PROFILING</tt></a></dt>
 630     <dd>If set to any value, causes the build to generate both optimized and
 631     profiled objects, libraries and executables. This alters the flags specified
 632     to the compilers and linkers to ensure that profile data can be collected
 633     from the tools built. Use the <tt>gprof</tt> tool to analyze the output from
 634     the profiled tools (<tt>gmon.out</tt>).</dd>
 635     <dt><a name="ENABLE_ASSERTIONS"><tt>ENABLE_ASSERTIONS</tt></a></dt>
 636     <dd>If set to any value, causes the build to enable assertions, even if
 637     building a release or profile build.  This is slower than a release build
 638     but far faster than a debug build.</dd>
 639     <dt><a name="EXPERIMENTAL_DIRS"><tt>EXPERIMENTAL_DIRS</tt></a></dt>
 640     <dd>Specify a set of directories that should be built, but if they fail, it
 641     should not cause the build to fail. Note that this should only be used
 642     temporarily while code is being written.</dd>
 643     <dt><a name="EXPORTED_SYMBOL_FILE"><tt>EXPORTED_SYMBOL_FILE</tt></a></dt>
 644     <dd>Specifies the name of a single file that contains a list of the
 645     symbols to be exported by the linker. One symbol per line.</dd>
 646     <dt><a name="EXPORTED_SYMBOL_LIST"><tt>EXPORTED_SYMBOL_LIST</tt></a></dt>
 647     <dd>Specifies a set of symbols to be exported by the linker.</dd>
 648     <dt><a name="EXTRA_DIST"><tt>EXTRA_DIST</tt></a></dt>
 649     <dd>Specifies additional files that should be distributed with LLVM. All
 650     source files, all built sources, all Makefiles, and most documentation files
 651     will be automatically distributed. Use this variable to distribute any
 652     files that are not automatically distributed.</dd>
 653     <dt><a name="KEEP_SYMBOLS"><tt>KEEP_SYMBOLS</tt></a></dt>
 654     <dd>If set to any value, specifies that when linking executables the
 655     makefiles should retain debug symbols in the executable. Normally, symbols
 656     are stripped from the executable.</dd>
 657     <dt><a name="LEVEL"><tt>LEVEL</tt></a><small>(required)</small></dt>
 658     <dd>Specify the level of nesting from the top level. This variable must be
 659     set in each makefile as it is used to find the top level and thus the other
 660     makefiles.</dd>
 661     <dt><a name="LIBRARYNAME"><tt>LIBRARYNAME</tt></a></dt>
 662     <dd>Specify the name of the library to be built. (Required For
 663     Libraries)</dd>
 664     <dt><a name="LLVMLIBS"><tt>LLVMLIBS</tt></a></dt>
 665     <dd>Specifies the set of libraries from the LLVM $(ObjDir) that will be
 666     linked into the tool or library.</dd>
 667     <dt><a name="LOADABLE_MODULE"><tt>LOADABLE_MODULE</tt></a></dt>
 668     <dd>If set to any value, causes the shared library being built to also be
 669     a loadable module. Loadable modules can be opened with the dlopen() function
 670     and searched with dlsym (or the operating system's equivalent). Note that
 671     setting this variable without also setting <tt>SHARED_LIBRARY</tt> will have
 672     no effect.</dd>
 673     <dt><a name="MODULE_NAME"><tt>MODULE_NAME</tt></a></dt>
 674     <dd>Specifies the name of a bytecode module to be created. A bytecode
 675     module can be specified in conjunction with other kinds of library builds
 676     or by itself. It constructs from the sources a single linked bytecode
 677     file.</dd>
 678     <dt><a name="OPTIONAL_DIRS"><tt>OPTIONAL_DIRS</tt></a></dt>
 679     <dd>Specify a set of directories that may be built, if they exist, but its
 680     not an error for them not to exist.</dd>
 681     <dt><a name="PARALLEL_DIRS"><tt>PARALLEL_DIRS</tt></a></dt>
 682     <dd>Specify a set of directories to build recursively and in parallel if
 683     the -j option was used with <tt>make</tt>.</dd>
 684     <dt><a name="SHARED_LIBRARY"><tt>SHARED_LIBRARY</tt></a></dt>
 685     <dd>If set to any value, causes a shared library (.so) to be built in
 686     addition to any other kinds of libraries. Note that this option will cause
 687     all source files to be built twice: once with options for position
 688     independent code and once without. Use it only where you really need a
 689     shared library.</dd>
 690     <dt><a name="SOURCES"><tt>SOURCES</tt><small>(optional)</small></a></dt>
 691     <dd>Specifies the list of source files in the current directory to be
 692     built. Source files of any type may be specified (programs, documentation,
 693     config files, etc.). If not specified, the makefile system will infer the
 694     set of source files from the files present in the current directory.</dd>
 695     <dt><a name="SUFFIXES"><tt>SUFFIXES</tt></a></dt>
 696     <dd>Specifies a set of filename suffixes that occur in suffix match rules.
 697     Only set this if your local <tt>Makefile</tt> specifies additional suffix
 698     match rules.</dd>
 699     <dt><a name="TARGET"><tt>TARGET</tt></a></dt>
 700     <dd>Specifies the name of the LLVM code generation target that the
 701     current directory builds. Setting this variable enables additional rules to
 702     build <tt>.inc</tt> files from <tt>.td</tt> files. </dd>
 703     <dt><a name="TESTSUITE"><tt>TESTSUITE</tt></a></dt>
 704     <dd>Specifies the directory of tests to run in <tt>llvm/test</tt>.</dd>
 705     <dt><a name="TOOLNAME"><tt>TOOLNAME</tt></a></dt>
 706     <dd>Specifies the name of the tool that the current directory should
 707     build.</dd>
 708     <dt><a name="TOOL_VERBOSE"><tt>TOOL_VERBOSE</tt></a></dt>
 709     <dd>Implies VERBOSE and also tells each tool invoked to be verbose. This is
 710     handy when you're trying to see the sub-tools invoked by each tool invoked
 711     by the makefile. For example, this will pass <tt>-v</tt> to the GCC
 712     compilers which causes it to print out the command lines it uses to invoke
 713     sub-tools (compiler, assembler, linker).</dd>
 714     <dt><a name="USEDLIBS"><tt>USEDLIBS</tt></a></dt>
 715     <dd>Specifies the list of project libraries that will be linked into the
 716     tool or library.</dd>
 717     <dt><a name="VERBOSE"><tt>VERBOSE</tt></a></dt>
 718     <dd>Tells the Makefile system to produce detailed output of what it is doing
 719     instead of just summary comments. This will generate a LOT of output.</dd>
 720   </dl>
 721 </div>
 722
 723 <!-- ======================================================================= -->
 724 <div class="doc_subsection"><a name="overvars">Override Variables</a></div>
 725 <div class="doc_text">
 726   <p>Override variables can be used to override the default
 727   values provided by the LLVM makefile system. These variables can be set in
 728   several ways:</p>
 729   <ul>
 730     <li>In the environment (e.g. setenv, export) -- not recommended.</li>
 731     <li>On the <tt>make</tt> command line -- recommended.</li>
 732     <li>On the <tt>configure</tt> command line</li>
 733     <li>In the Makefile (only <em>after</em> the inclusion of <a
 734     href="#Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>).</li>
 735   </ul>
 736   <p>The override variables are given below:</p>
 737   <dl>
 738     <dt><a name="AR"><tt>AR</tt></a> <small>(defaulted)</small></dt>
 739     <dd>Specifies the path to the <tt>ar</tt> tool.</dd>
 740     <dt><a name="BISON"><tt>BISON</tt></a><small>(configured)</small></dt>
 741     <dd>Specifies the path to the <tt>bison</tt> tool.</dd>
 742     <dt><a name="PROJ_OBJ_DIR"><tt>PROJ_OBJ_DIR</tt></a></dt>
 743     <dd>The directory into which the products of build rules will be placed.
 744     This might be the same as
 745     <a href="#PROJ_SRC_DIR"><tt>PROJ_SRC_DIR</tt></a> but typically is
 746     not.</dd>
 747     <dt><a name="PROJ_SRC_DIR"><tt>PROJ_SRC_DIR</tt></a></dt>
 748     <dd>The directory which contains the source files to be built.</dd>
 749     <dt><a name="BURG"><tt>BURG</tt></a></dt>
 750     <dd>Specifies the path to the <tt>burg</tt> tool.</dd>
 751     <dt><a name="BZIP2"><tt>BZIP2</tt></a><small>(configured)</small></dt>
 752     <dd>The path to the <tt>bzip2</tt> tool.</dd>
 753     <dt><a name="CC"><tt>CC</tt></a><small>(configured)</small></dt>
 754     <dd>The path to the 'C' compiler.</dd>
 755     <dt><a name="CFLAGS"><tt>CFLAGS</tt></a></dt>
 756     <dd>Additional flags to be passed to the 'C' compiler.</dd>
 757     <dt><a name="CXX"><tt>CXX</tt></a></dt>
 758     <dd>Specifies the path to the C++ compiler.</dd>
 759     <dt><a name="CXXFLAGS"><tt>CXXFLAGS</tt></a></dt>
 760     <dd>Additional flags to be passed to the C++ compiler.</dd>
 761     <dt><a name="DATE"><tt>DATE<small>(configured)</small></tt></a></dt>
 762     <dd>Specifies the path to the <tt>date</tt> program or any program that can
 763     generate the current date and time on its standard output</dd>
 764     <dt><a name="DOT"><tt>DOT</tt></a><small>(configured)</small></dt>
 765     <dd>Specifies the path to the <tt>dot</tt> tool or <tt>false</tt> if there
 766     isn't one.</dd>
 767     <dt><a name="ECHO"><tt>ECHO</tt></a><small>(configured)</small></dt>
 768     <dd>Specifies the path to the <tt>echo</tt> tool for printing output.</dd>
 769     <dt><a name="ETAGS"><tt>ETAGS</tt></a><small>(configured)</small></dt>
 770     <dd>Specifies the path to the <tt>etags</tt> tool.</dd>
 771     <dt><a name="ETAGSFLAGS"><tt>ETAGSFLAGS</tt></a><small>(configured)</small>
 772     </dt>
 773     <dd>Provides flags to be passed to the <tt>etags</tt> tool.</dd>
 774     <dt><a name="EXEEXT"><tt>EXEEXT</tt></a><small>(configured)</small></dt>
 775     <dd>Provides the extension to be used on executables built by the makefiles.
 776     The value may be empty on platforms that do not use file extensions for
 777     executables (e.g. Unix).</dd>
 778     <dt><a name="FLEX"><tt>FLEX</tt></a><small>(configured)</small></dt>
 779     <dd>Specifies the path to the <tt>flex</tt> tool.</dd>
 780     <dt><a name="GCCLD"><tt>GCCLD</tt></a><small>(defaulted)</small></dt>
 781     <dd>Specifies the path to the <tt>gccld</tt> tool.</dd>
 782     <dt><a name="INSTALL"><tt>INSTALL</tt></a><small>(configured)</small></dt>
 783     <dd>Specifies the path to the <tt>install</tt> tool.</dd>
 784     <dt><a name="LDFLAGS"><tt>LDFLAGS</tt></a><small>(configured)</small></dt>
 785     <dd>Allows users to specify additional flags to pass to the linker.</dd>
 786     <dt><a name="LIBS"><tt>LIBS</tt></a><small>(configured)</small></dt>
 787     <dd>The list of libraries that should be linked with each tool.</dd>
 788     <dt><a name="LIBTOOL"><tt>LIBTOOL</tt></a><small>(configured)</small></dt>
 789     <dd>Specifies the path to the <tt>libtool</tt> tool. This tool is renamed
 790     <tt>mklib</tt> by the <tt>configure</tt> script and always located in the
 791     <dt><a name="LLVMAS"><tt>LLVMAS</tt></a><small>(defaulted)</small></dt>
 792     <dd>Specifies the path to the <tt>llvm-as</tt> tool.</dd>
 793     <dt><a name="LLVMGCC"><tt>LLVMGCC</tt></a><small>(defaulted)</small></dt>
 794     <dd>Specifies the path to the LLVM version of the GCC 'C' Compiler</dd>
 795     <dt><a name="LLVMGXX"><tt>LLVMGXX</tt></a><small>(defaulted)</small></dt>
 796     <dd>Specifies the path to the LLVM version of the GCC C++ Compiler</dd>
 797     <dt><a name="LLVM_OBJ_ROOT"><tt>LLVM_OBJ_ROOT</tt></a><small>(configured)
 798     </small></dt>
 799     <dd>Specifies the top directory into which the output of the build is
 800     placed.</dd>
 801     <dt><a name="LLVM_SRC_ROOT"><tt>LLVM_SRC_ROOT</tt></a><small>(configured)
 802     </small></dt>
 803     <dd>Specifies the top directory in which the sources are found.</dd>
 804     <dt><a name="LLVM_TARBALL_NAME"><tt>LLVM_TARBALL_NAME</tt></a>
 805     <small>(configured)</small></dt>
 806     <dd>Specifies the name of the distribution tarball to create. This is
 807     configured from the name of the project and its version number.</dd>
 808     <dt><a name="MKDIR"><tt>MKDIR</tt></a><small>(defaulted)</small></dt>
 809     <dd>Specifies the path to the <tt>mkdir</tt> tool that creates
 810     directories.</dd>
 811     <dt><a name="PLATFORMSTRIPOPTS"><tt>PLATFORMSTRIPOPTS</tt></a></dt>
 812     <dd>The options to provide to the linker to specify that a stripped (no
 813     symbols) executable should be built.</dd>
 814     <dt><a name="RANLIB"><tt>RANLIB</tt></a><small>(defaulted)</small></dt>
 815     <dd>Specifies the path to the <tt>ranlib</tt> tool.</dd>
 816     <dt><a name="RM"><tt>RM</tt></a><small>(defaulted)</small></dt>
 817     <dd>Specifies the path to the <tt>rm</tt> tool.</dd>
 818     <dt><a name="SED"><tt>SED</tt></a><small>(defaulted)</small></dt>
 819     <dd>Specifies the path to the <tt>sed</tt> tool.</dd>
 820     <dt><a name="SHLIBEXT"><tt>SHLIBEXT</tt></a><small>(configured)</small></dt>
 821     <dd>Provides the filename extension to use for shared libraries.</dd>
 822     <dt><a name="TBLGEN"><tt>TBLGEN</tt></a><small>(defaulted)</small></dt>
 823     <dd>Specifies the path to the <tt>tblgen</tt> tool.</dd>
 824     <dt><a name="TAR"><tt>TAR</tt></a><small>(defaulted)</small></dt>
 825     <dd>Specifies the path to the <tt>tar</tt> tool.</dd>
 826     <dt><a name="ZIP"><tt>ZIP</tt></a><small>(defaulted)</small></dt>
 827     <dd>Specifies the path to the <tt>zip</tt> tool.</dd>
 828   </dl>
 829 </div>
 830
 831 <!-- ======================================================================= -->
 832 <div class="doc_subsection"><a name="getvars">Readable Variables</a></div>
 833 <div class="doc_text">
 834   <p>Variables listed in the table below can be used by the user's Makefile but
 835   should not be changed. Changing the value will generally cause the build to go
 836   wrong, so don't do it.</p>
 837   <dl>
 838     <dt><a name="bindir"><tt>bindir</tt></a></dt>
 839     <dd>The directory into which executables will ultimately be installed. This
 840     value is derived from the <tt>--prefix</tt> option given to
 841     <tt>configure</tt>.</dd>
 842     <dt><a name="BuildMode"><tt>BuildMode</tt></a></dt>
 843     <dd>The name of the type of build being performed: Debug, Release, or
 844     Profile</dd>
 845     <dt><a name="bytecode_libdir"><tt>bytecode_libdir</tt></a></dt>
 846     <dd>The directory into which bytecode libraries will ultimately be
 847     installed.  This value is derived from the <tt>--prefix</tt> option given to
 848     <tt>configure</tt>.</dd>
 849     <dt><a name="ConfigureScriptFLAGS"><tt>ConfigureScriptFLAGS</tt></a></dt>
 850     <dd>Additional flags given to the <tt>configure</tt> script when
 851     reconfiguring.</dd>
 852     <dt><a name="DistDir"><tt>DistDir</tt></a></dt>
 853     <dd>The <em>current</em> directory for which a distribution copy is being
 854     made.</dd>
 855     <dt><a name="Echo"><tt>Echo</tt></a></dt>
 856     <dd>The LLVM Makefile System output command. This provides the
 857     <tt>llvm[n]</tt> prefix and starts with @ so the command itself is not
 858     printed by <tt>make</tt>.</dd>
 859     <dt><a name="EchoCmd"><tt>EchoCmd</tt></a></dt>
 860     <dd> Same as <a href="#Echo"><tt>Echo</tt></a> but without the leading @.
 861     </dd>
 862     <dt><a name="includedir"><tt>includedir</tt></a></dt>
 863     <dd>The directory into which include files will ultimately be installed.
 864     This value is derived from the <tt>--prefix</tt> option given to
 865     <tt>configure</tt>.</dd>
 866     <dt><a name="libdir"><tt>libdir</tt></a></dt><dd></dd>
 867     <dd>The directory into which native libraries will ultimately be installed.
 868     This value is derived from the <tt>--prefix</tt> option given to
 869     <tt>configure</tt>.</dd>
 870     <dt><a name="LibDir"><tt>LibDir</tt></a></dt>
 871     <dd>The configuration specific directory into which libraries are placed
 872     before installation.</dd>
 873     <dt><a name="MakefileConfig"><tt>MakefileConfig</tt></a></dt>
 874     <dd>Full path of the <tt>Makefile.config</tt> file.</dd>
 875     <dt><a name="MakefileConfigIn"><tt>MakefileConfigIn</tt></a></dt>
 876     <dd>Full path of the <tt>Makefile.config.in</tt> file.</dd>
 877     <dt><a name="ObjDir"><tt>ObjDir</tt></a></dt>
 878     <dd>The configuration and directory specific directory where build objects
 879     (compilation results) are placed.</dd>
 880     <dt><a name="SubDirs"><tt>SubDirs</tt></a></dt>
 881     <dd>The complete list of sub-directories of the current directory as
 882     specified by other variables.</dd>
 883     <dt><a name="Sources"><tt>Sources</tt></a></dt>
 884     <dd>The complete list of source files.</dd>
 885     <dt><a name="sysconfdir"><tt>sysconfdir</tt></a></dt>
 886     <dd>The directory into which configuration files will ultimately be
 887     installed. This value is derived from the <tt>--prefix</tt> option given to
 888     <tt>configure</tt>.</dd>
 889     <dt><a name="ToolDir"><tt>ToolDir</tt></a></dt>
 890     <dd>The configuration specific directory into which executables are placed
 891     before they are installed.</dd>
 892     <dt><a name="TopDistDir"><tt>TopDistDir</tt></a></dt>
 893     <dd>The top most directory into which the distribution files are copied.
 894     </dd>
 895     <dt><a name="Verb"><tt>Verb</tt></a></dt>
 896     <dd>Use this as the first thing on your build script lines to enable or
 897     disable verbose mode. It expands to either an @ (quiet mode) or nothing
 898     (verbose mode). </dd>
 899   </dl>
 900 </div>
 901
 902 <!-- ======================================================================= -->
 903 <div class="doc_subsection"><a name="intvars">Internal Variables</a></div>
 904 <div class="doc_text">
 905   <p>Variables listed below are used by the LLVM Makefile System
 906   and considered internal. You should not use these variables under any
 907   circumstances.</p>
 908   <p><tt>
 909     Archive
 910     AR.Flags
 911     BaseNameSources
 912     BCCompile.C
 913     BCCompile.CXX
 914     BCLinkLib
 915     Burg
 916     C.Flags
 917     Compile.C
 918     CompileCommonOpts
 919     Compile.CXX
 920     ConfigStatusScript
 921     ConfigureScript
 922     CPP.Flags
 923     CPP.Flags
 924     CXX.Flags
 925     DependFiles
 926     DestArchiveLib
 927     DestBytecodeLib
 928     DestModule
 929     DestRelinkedLib
 930     DestSharedLib
 931     DestTool
 932     DistAlways
 933     DistCheckDir
 934     DistCheckTop
 935     DistFiles
 936     DistName
 937     DistOther
 938     DistSources
 939     DistSubDirs
 940     DistTarBZ2
 941     DistTarGZip
 942     DistZip
 943     ExtraLibs
 944     FakeSources
 945     INCFiles
 946     InternalTargets
 947     LD.Flags
 948     LexFiles
 949     LexOutput
 950     LibName.A
 951     LibName.BC
 952     LibName.LA
 953     LibName.O
 954     LibTool.Flags
 955     Link
 956     LinkModule
 957     LLVMLibDir
 958     LLVMLibsOptions
 959     LLVMLibsPaths
 960     LLVMToolDir
 961     LLVMUsedLibs
 962     LocalTargets
 963     LTCompile.C
 964     LTCompile.CXX
 965     LTInstall
 966     Module
 967     ObjectsBC
 968     ObjectsLO
 969     ObjectsO
 970     ObjMakefiles
 971     ParallelTargets
 972     PreConditions
 973     ProjLibsOptions
 974     ProjLibsPaths
 975     ProjUsedLibs
 976     Ranlib
 977     RecursiveTargets
 978     Relink
 979     SrcMakefiles
 980     Strip
 981     StripWarnMsg
 982     TableGen
 983     TDFiles
 984     ToolBuildPath
 985     TopLevelTargets
 986     UserTargets
 987     YaccFiles
 988     YaccOutput
 989   </tt></p>
 990 </div>
 991
 992 <!-- *********************************************************************** -->
 993 <hr>
 994 <address>
 995   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 996   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 997   <a href="http://validator.w3.org/check/referer"><img
 998   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 999
1000   <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br>
1001   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
1002   Last modified: $Date$
1003 </address>
1004 </body>
1005 </html>