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