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