Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 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="#Makefile">Makefile</a></li> |
| 18 | <li><a href="#Makefile.common">Makefile.common</a></li> |
| 19 | <li><a href="#Makefile.config">Makefile.config</a></li> |
Chris Lattner | 72f0891 | 2004-10-25 19:28:03 +0000 | [diff] [blame] | 20 | <li><a href="#Makefile.rules">Makefile.rules</a></li> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 21 | <li><a href="#Comments">Comments</a></li> |
| 22 | </ol> |
| 23 | </li> |
| 24 | <li><a href="#targets">Targets Supported</a> |
| 25 | <ol> |
| 26 | <li><a href="#all">all</a></li> |
| 27 | <li><a href="#all-local">all-local</a></li> |
| 28 | <li><a href="#check">check</a></li> |
| 29 | <li><a href="#check-local">check-local</a></li> |
| 30 | <li><a href="#clean">clean</a></li> |
| 31 | <li><a href="#clean-local">clean-local</a></li> |
| 32 | <li><a href="#dist">dist</a></li> |
| 33 | <li><a href="#dist-check">dist-check</a></li> |
| 34 | <li><a href="#dist-clean">dist-clean</a></li> |
| 35 | <li><a href="#install">install</a></li> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 36 | <li><a href="#printvars">printvars</a></li> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 37 | <li><a href="#tags">tags</a></li> |
| 38 | <li><a href="#uninstall">uninstall</a></li> |
| 39 | </ol> |
| 40 | </li> |
| 41 | <li><a href="#variables">Using Variables</a> |
| 42 | <ol> |
| 43 | <li><a href="#setvars">Control Variables</a></li> |
| 44 | <li><a href="#overvars">Override Variables</a></li> |
| 45 | <li><a href="#getvars">Readable Variables</a></li> |
Reid Spencer | a79e58c | 2004-10-30 21:39:42 +0000 | [diff] [blame] | 46 | <li><a href="#intvars">Internal Variables</a></li> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 47 | </ol> |
| 48 | </li> |
| 49 | </ol> |
| 50 | |
| 51 | <div class="doc_author"> |
| 52 | <p>Written by <a href="mailto:reid@x10sys.com">Reid Spencer</a></p> |
| 53 | </div> |
| 54 | |
| 55 | <!-- *********************************************************************** --> |
| 56 | <div class="doc_section"><a name="introduction">Introduction </a></div> |
| 57 | <!-- *********************************************************************** --> |
| 58 | |
| 59 | <div class="doc_text"> |
| 60 | <p>This document provides <em>usage</em> information about the LLVM makefile |
| 61 | system. While loosely patterned after the BSD makefile system, LLVM has taken |
Chris Lattner | 72f0891 | 2004-10-25 19:28:03 +0000 | [diff] [blame] | 62 | a departure from BSD in order to implement additional features needed by LLVM. |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 63 | </p> |
| 64 | <p>Although makefile systems such as automake were attempted at one point, it |
Chris Lattner | 23da730 | 2004-10-25 19:37:46 +0000 | [diff] [blame] | 65 | has become clear that the differences between the LLVM way of doing things and |
| 66 | the Makefile norm are too great to use a more limited tool. Consequently, LLVM requires |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 67 | simply GNU Make 3.79, a widely portably makefile processor. LLVM unabashedly |
| 68 | makes heavy use of the features of GNU Make so the dependency on GNU Make is |
| 69 | firm. If you're not familiar with <tt>make</tt>, it is recommended that you |
| 70 | read the <a href="http://www.gnu.org/software/make/manual/make.html"> |
| 71 | GNU Makefile Manual</a>.</p> |
| 72 | <p>While this document is rightly part of the |
| 73 | <a href="ProgrammersManual.html">LLVM Programmer's Manual</a>, it is treated |
| 74 | separately here because of the volume of content and because it is often an |
| 75 | early source of bewilderment for new developers.</p> |
| 76 | </div> |
| 77 | |
| 78 | <!-- *********************************************************************** --> |
| 79 | <div class="doc_section"><a name="general">General Concepts</a></div> |
| 80 | <!-- *********************************************************************** --> |
| 81 | |
| 82 | <div class="doc_text"> |
| 83 | <p>The LLVM makefile system is the component of LLVM that is responsible for |
| 84 | building the software, testing it, generating distributions, rpms and other |
| 85 | packages, installing and uninstalling, etc.</p> |
| 86 | </div> |
| 87 | |
| 88 | <!-- ======================================================================= --> |
| 89 | <div class="doc_subsection"><a name="projects">Projects</a></div> |
| 90 | <div class="doc_text"> |
| 91 | <p>The LLVM Makefile System is quite generous. It not only builds its own |
| 92 | software, but it can build yours too. Built into the system is knowledge of |
| 93 | the <tt>llvm/projects</tt> directory. Any directory under <tt>projects</tt> |
| 94 | that has both a <tt>configure</tt> script and a <tt>Makefile</tt> is assumed |
| 95 | to be a project that uses the LLVM Makefile system. This allows your project |
| 96 | to get up and running quickly by utilizing the built-in features that are used |
| 97 | to compile LLVM.</p> |
| 98 | </div> |
| 99 | |
| 100 | <!-- ======================================================================= --> |
| 101 | <div class="doc_subsection"><a name="Makefile">Makefile</a></div> |
| 102 | <div class="doc_text"> |
| 103 | <p>Each directory to participate in the build needs to have a file named |
| 104 | <tt>Makefile</tt>. This is the file first read by <tt>make</tt>. It has three |
| 105 | sections:</p> |
| 106 | <ol> |
| 107 | <li><a href="setvars">Settable Variables</a> - Required that must be set |
| 108 | first.</li> |
| 109 | <li><a href="Makefile.common">include <tt>$(LEVEL)/Makefile.common</tt></a> |
| 110 | - include the LLVM Makefile system. |
| 111 | <li><a href="overvars">Overridable Variables</a> - Override variables set by |
| 112 | the LLVM Makefile system. |
| 113 | </ol> |
| 114 | </div> |
| 115 | |
| 116 | <!-- ======================================================================= --> |
| 117 | <div class="doc_subsection"><a name="Makefile.common">Makefile.common</a></div> |
| 118 | <div class="doc_text"> |
| 119 | <p>Every project must have a <tt>Makefile.common</tt> file at its top source |
| 120 | directory. This file serves three purposes:</p> |
| 121 | <ol> |
| 122 | <li>It includes the project's configuration makefile to obtain values |
| 123 | determined by the <tt>configure</tt> script. This is done by including the |
| 124 | <a href="Makefile.config"><tt>$(LEVEL)/Makefile.config</tt></a> file.</li> |
| 125 | <li>It specifies any other (static) values that are needed throughout the |
| 126 | project. Only values that are used in all or a large proportion of the |
| 127 | project's directories should be placed here.</li> |
| 128 | <li>It include's the standard rules for the LLVM Makefile system, |
| 129 | <a href="Makefile.rules"><tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt></a>. |
| 130 | This file is the "guts" of the LLVM Makefile system.</li> |
| 131 | </ol> |
| 132 | </div> |
| 133 | |
| 134 | <!-- ======================================================================= --> |
| 135 | <div class="doc_subsection"><a name="Makefile.config">Makefile.config</a></div> |
| 136 | <div class="doc_text"> |
| 137 | <p>Every project must have a <tt>Makefile.config</tt> at the top of its |
| 138 | <em>build</em> directory. This file is <b>generated</b> by the |
| 139 | <tt>configure</tt> script from the pattern provided by the |
| 140 | <tt>Makefile.config.in</tt> file located at the top of the project's |
| 141 | <em>source</em> directory. The contents of this file depend largely on what |
| 142 | configuration items the project uses, however most projects can get what they |
| 143 | need by just relying on LLVM's configuration found in |
| 144 | <tt>$(LLVM_OBJ_ROOT)/Makefile.config</tt>. |
| 145 | </div> |
| 146 | |
| 147 | <!-- ======================================================================= --> |
| 148 | <div class="doc_subsection"><a name="Makefile.rules">Makefile.rules</a></div> |
| 149 | <div class="doc_text"> |
| 150 | <p>This file, located at <tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt> is the heart |
| 151 | of the LLVM Makefile System. It provides all the logic, dependencies, and |
| 152 | rules for building the targets supported by the system. What it does largely |
| 153 | depends on the values of <tt>make</tt> <a href="variables">variables</a> that |
| 154 | have been set <em>before</em> <tt>Makefile.rules</tt> is included. |
| 155 | </div> |
| 156 | |
| 157 | <!-- ======================================================================= --> |
| 158 | <div class="doc_subsection"><a name="Comments">Comments</a></div> |
| 159 | <div class="doc_text"> |
| 160 | <p>User Makefiles need not have comments in them unless the construction is |
| 161 | unusual or it doesn't strictly follow the rules and patterns of the LLVM |
| 162 | makefile system. Makefile comments are invoked with the pound (#) character. |
| 163 | The # character and any text following it, to the end of the line, are ignored |
| 164 | by <tt>make</tt>.</p> |
| 165 | </div> |
| 166 | |
| 167 | <!-- *********************************************************************** --> |
| 168 | <div class="doc_section"><a name="targets">Targets Supported</a></div> |
| 169 | <!-- *********************************************************************** --> |
| 170 | |
| 171 | <div class="doc_text"> |
| 172 | <p>This section describes each of the targets that can be built using the LLVM |
| 173 | Makefile system. Any target can be invoked from any directory but not all are |
Chris Lattner | 72f0891 | 2004-10-25 19:28:03 +0000 | [diff] [blame] | 174 | applicable to a given directory (e.g. "dist" and "install" will always operate |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 175 | as if invoked from the top level directory).</p> |
| 176 | |
| 177 | <table style="text-align:left"> |
| 178 | <tr><th>Target Name</th><th>Implied Targets</th><th>Target Description</th></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 179 | <tr><td><a href="#all"><tt>all</tt></a></td><td></td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 180 | <td>Compile the software recursively. Default target. |
| 181 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 182 | <tr><td><a href="#all-local"><tt>all-local</tt></a></td><td></td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 183 | <td>Compile the software in the local directory only. |
| 184 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 185 | <tr><td><a href="#check"><tt>check</tt></a></td><td>all</td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 186 | <td>Test the software recursively. |
| 187 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 188 | <tr><td><a href="#check-local"><tt>check-local</tt></a></td><td>all-local</td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 189 | <td>Test the software in the local directory only. |
| 190 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 191 | <tr><td><a href="#clean"><tt>clean</tt></a></td><td></td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 192 | <td>Remove built objects recursively. |
| 193 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 194 | <tr><td><a href="#clean-local"><tt>clean-local</tt></a></td><td></td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 195 | <td>Remove built objects from the local directory only. |
| 196 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 197 | <tr><td><a href="#dist"><tt>dist</tt></a></td><td>all</td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 198 | <td>Prepare a source distribution tarball. |
| 199 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 200 | <tr><td><a href="#dist-check"><tt>dist-check</tt></a></td><td>all check</td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 201 | <td>Prepare a source distribution tarball and check that it builds. |
| 202 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 203 | <tr><td><a href="#dist-clean"><tt>dist-clean</tt></a></td><td>clean</td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 204 | <td>Clean source distribution tarball temporary files. |
| 205 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 206 | <tr><td><a href="#install"><tt>install</tt></a></td><td>all</td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 207 | <td>Copy built objects to installation directory. |
| 208 | </td></tr> |
Reid Spencer | a79e58c | 2004-10-30 21:39:42 +0000 | [diff] [blame] | 209 | <tr><td><a href="#printvars"><tt>printvars</tt></a></td><td>all</td> |
| 210 | <td>Prints variables defined by the makefile system (for debugging). |
| 211 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 212 | <tr><td><a href="#tags"><tt>tags</tt></a></td><td></td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 213 | <td>Make C and C++ tags files for emacs and vi. |
| 214 | </td></tr> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 215 | <tr><td><a href="#uninstall"><tt>uninstall</tt></a></td><td></td> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 216 | <td>Remove built objects from installation directory. |
| 217 | </td></tr> |
| 218 | </table> |
| 219 | </div> |
| 220 | |
| 221 | <!-- ======================================================================= --> |
| 222 | <div class="doc_subsection"><a name="all">all (default)</a></div> |
| 223 | <div class="doc_text"> |
| 224 | <p>When you invoke <tt>make</tt> with no arguments, you are implicitly |
| 225 | instructing it to seek the "all" target (goal). This target is used for |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 226 | building the software recursively and will do different things in different |
| 227 | directories. For example, in a <tt>lib</tt> directory, the "all" target will |
| 228 | compile source files and generate libraries. But, in a <tt>tools</tt> |
| 229 | directory, it will link libraries and generate executables.</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 230 | </div> |
| 231 | |
| 232 | <!-- ======================================================================= --> |
| 233 | <div class="doc_subsection"><a name="all-local">all-local</a></div> |
| 234 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 235 | <p>This target is the same as <a href="#all">all</a> but it operates only on |
| 236 | the current directory instead of recursively.</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 237 | </div> |
| 238 | |
| 239 | <!-- ======================================================================= --> |
| 240 | <div class="doc_subsection"><a name="check">check</a></div> |
| 241 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 242 | <p>This target is used to perform any functional, unit or sanity tests as the |
| 243 | software is being built. The <tt>check</tt> target depends on the |
| 244 | <a href="#all"><tt>all</tt></a> target so the software is built in each |
| 245 | directory first and then the "check" is applied.</p> |
| 246 | <p>The definition of "check" is pretty general. It depends on the value of the |
| 247 | <a href="#TESTS"><tt>TESTS</tt></a> variable. This variable should be set to a |
| 248 | list of executables to run in order to test the software. If they all return |
| 249 | 0 then the check succeeds, otherwise not. The programs run can be anything but |
| 250 | they should either be local to the directory or in your path.</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 251 | </div> |
| 252 | |
| 253 | <!-- ======================================================================= --> |
| 254 | <div class="doc_subsection"><a name="check-local">check-local</a></div> |
| 255 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 256 | <p>This target does the same thing as <tt>check</tt> but only for the current |
| 257 | (local) directory.</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 258 | </div> |
| 259 | |
| 260 | <!-- ======================================================================= --> |
| 261 | <div class="doc_subsection"><a name="clean">clean</a></div> |
| 262 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 263 | <p>This target cleans the build directory, recursively removing all things |
| 264 | that the Makefile builds. Despite once or twice attempting to remove /*, the |
Chris Lattner | 72f0891 | 2004-10-25 19:28:03 +0000 | [diff] [blame] | 265 | cleaning rules have been made guarded so they shouldn't go awry.</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 266 | </div> |
| 267 | |
| 268 | <!-- ======================================================================= --> |
| 269 | <div class="doc_subsection"><a name="clean-local">clean-local</a></div> |
| 270 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 271 | <p>This target does the same thing as <tt>clean</tt> but only for the current |
| 272 | (local) directory.</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 273 | </div> |
| 274 | |
| 275 | <!-- ======================================================================= --> |
| 276 | <div class="doc_subsection"><a name="dist">dist</a></div> |
| 277 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 278 | <p>This target builds a distribution tarball. It first builds the entire |
| 279 | project using the <tt>all</tt> target and then tars up the necessary files and |
| 280 | compresses it. The generated tarball is sufficient for a casual source |
| 281 | distribution, but probably not for a release (see <tt>dist-check</tt>).</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 282 | </div> |
| 283 | |
| 284 | <!-- ======================================================================= --> |
| 285 | <div class="doc_subsection"><a name="dist-check">dist-check</a></div> |
| 286 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 287 | <p>This target does the same thing as the <tt>dist</tt> target but also checks |
| 288 | the distribution tarball. The check is made by unpacking the tarball to a new |
| 289 | directory, configuring it, building it, installing it, and then verifying that |
| 290 | the installation results are correct (by comparing to the original build). |
| 291 | This target can take a long time to run but should be done before a release |
| 292 | goes out to make sure that the distributed tarball can actually be built into |
| 293 | a working release.</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 294 | </div> |
| 295 | |
| 296 | <!-- ======================================================================= --> |
| 297 | <div class="doc_subsection"><a name="dist-clean">dist-clean</a></div> |
| 298 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 299 | <p>This is a special form of the <tt>clean</tt> clean target. It performs a |
| 300 | normal <tt>clean</tt> but also removes things pertaining to building the |
| 301 | distribution.</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 302 | </div> |
| 303 | |
| 304 | <!-- ======================================================================= --> |
| 305 | <div class="doc_subsection"><a name="install">install</a></div> |
| 306 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 307 | <p>This target finalizes shared objects and executables and copies all |
| 308 | libraries, headers and executables to the directory given with the |
| 309 | <tt>--prefix</tt> option to <tt>configure</tt>. When completed, the prefix |
| 310 | directory will have everything needed to <b>use</b> LLVM. </p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 311 | </div> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 312 | |
| 313 | <!-- ======================================================================= --> |
| 314 | <div class="doc_subsection"><a name="printvars">printvars</a></div> |
| 315 | <div class="doc_text"> |
| 316 | <p>This utility target just causes LLVM to print out some of its variables so |
| 317 | that you can double check how things are set. </p> |
| 318 | </div> |
| 319 | |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 320 | <!-- ======================================================================= --> |
| 321 | <div class="doc_subsection"><a name="tags">tags</a></div> |
| 322 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 323 | <p>This target will generate a <tt>TAGS</tt> file in the top-level source |
| 324 | directory. It is meant for use with emacs, XEmacs, or ViM. The TAGS file |
| 325 | provides an index of symbol definitions so that the editor can jump you to the |
| 326 | definition quickly. </p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 327 | </div> |
| 328 | |
| 329 | <!-- ======================================================================= --> |
| 330 | <div class="doc_subsection"><a name="uninstall">uninstall</a></div> |
| 331 | <div class="doc_text"> |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 332 | <p>This target is the opposite of the <tt>install</tt> target. It removes the |
| 333 | header, library and executable files from the installation directories. Note |
Chris Lattner | 72f0891 | 2004-10-25 19:28:03 +0000 | [diff] [blame] | 334 | that the directories themselves are not removed because it is not guaranteed |
Reid Spencer | 714b52b | 2004-10-24 08:48:59 +0000 | [diff] [blame] | 335 | that LLVM is the only thing installing there (e.g. --prefix=/usr).</p> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 336 | </div> |
| 337 | |
| 338 | <!-- *********************************************************************** --> |
| 339 | <div class="doc_section"><a name="variables">Variables</a></div> |
| 340 | <!-- *********************************************************************** --> |
| 341 | <div class="doc_text"> |
| 342 | <p>Variables are used to tell the LLVM Makefile System what to do and to |
Reid Spencer | a79e58c | 2004-10-30 21:39:42 +0000 | [diff] [blame] | 343 | obtain information from it. Variables are also used internally by the LLVM |
| 344 | Makefile System. Variable names that contain only the upper case alphabetic |
| 345 | letters and underscore are intended for use by the end user. All other |
| 346 | variables are internal to the LLVM Makefile System and should not be relied |
| 347 | upon nor modified. The sections below describe how to use the LLVM Makefile |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 348 | variables.</p> |
| 349 | </div> |
| 350 | |
| 351 | <!-- ======================================================================= --> |
| 352 | <div class="doc_subsection"><a name="setvars">Control Variables</a></div> |
| 353 | <div class="doc_text"> |
| 354 | <p>Variables listed in the table below should be set <em>before</em> the |
| 355 | inclusion of <a href="Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>. |
| 356 | These variables provide input to the LLVM make system that tell it what to do |
| 357 | for the current directory.</p> |
Reid Spencer | a79e58c | 2004-10-30 21:39:42 +0000 | [diff] [blame] | 358 | <dl> |
| 359 | <dt><a name="BUILD_ARCHIVE"><tt>BUILD_ARCHIVE</tt></a></dt> |
| 360 | <dd>If set to any value, causes an archive (.a) library to be built.</dd> |
| 361 | <dt><a name="BUILT_SOURCES"><tt>BUILT_SOURCES</tt></a></dt> |
| 362 | <dd>Specifies a set of source files that are generated from other source |
| 363 | files. These sources will be built before any other target processing to |
| 364 | ensure they are present.</td> |
| 365 | <dt><a name="BYTECODE_LIBRARY"><tt>BYTECODE_LIBRARY</tt></a></dt> |
| 366 | <dd>If set to any value, causes a bytecode library (.bc) to be built.</dd> |
| 367 | <dt><a name="CONFIG_FILES"><tt>CONFIG_FILES</tt></a></dt> |
| 368 | <dd>Specifies a set of configuration files to be installed.</dd> |
| 369 | <dt><a name="DIRS"><tt>DIRS</tt></a></dt> |
| 370 | <dd>Specifies a set of directories, usually children of the current |
| 371 | directory, that should also be made using the same goal. These directories |
| 372 | will be built serially.</dd> |
| 373 | <dt><a name="DISABLE_AUTO_DEPENDENCIES"><tt>DISABLE_AUTO_DEPENDENCIES</tt></a></dt> |
| 374 | <dd>If set to any value, causes the makefiles to <b>not</b> automatically |
| 375 | generate dependencies when running the compiler. Use of this feature is |
| 376 | discouraged and it may be removed at a later date.</dd> |
| 377 | <dt><a name="DONT_BUILD_RELINKED"><tt>DONT_BUILD_RELINKED</tt></a></dt> |
| 378 | <dd>If set to any value, causes a relinked library (.o) not to be built. By |
| 379 | default, libraries are built as re-linked since most LLVM libraries are |
| 380 | needed in their entirety and re-linked libraries will be linked more quickly |
| 381 | than equival archive libraries.</dd> |
| 382 | <dt><a name="ENABLE_OPTIMIZED"><tt>ENABLE_OPTIMIZED</tt></a></dt> |
| 383 | <dd>If set to any value, causes the build to generate optimized objects, |
| 384 | libraries and executables. This alters the flags specified to the compilers |
| 385 | and linkers. Generally debugging won't be a fun experience with an optimized |
| 386 | build.</dd> |
| 387 | <dt><a name="ENABLE_PROFILING"><tt>ENABLE_PROFILING</tt></a></dt> |
| 388 | <dd>If set to any value, causes the build to generate both optimized and |
| 389 | profiled objects, libraries and executables. This alters the flags specified |
| 390 | to the compilers and linkers to ensure that profile data can be collected |
| 391 | from the tools built. Use the <tt>gprof</tt> tool to analyze the output from |
| 392 | the profiled tools (<tt>gmon.out</tt>).</dd> |
| 393 | <dt><a name="EXPERIMENTAL_DIRS"><tt>EXPERIMENTAL_DIRS</tt></a></dt> |
| 394 | <dd>Specify a set of directories that should be built, but if they fail, it |
| 395 | should not cause the build to fail. Note that this should only be used |
| 396 | temporarily while code is being written.</dd> |
| 397 | <dt><a name="EXPORTED_SYMBOL_FILE"><tt>EXPORTED_SYMBOL_FILE</tt></a></dt> |
| 398 | <dd>Specifies the name of a single file that contains a list of the |
| 399 | symbols to be exported by the linker. One symbol per line.</dd> |
| 400 | <dt><a name="EXPORTED_SYMBOL_LIST"><tt>EXPORTED_SYMBOL_LIST</tt></a></dt> |
| 401 | <dd>Specifies a set of symbols to be exported by the linker.</dd> |
| 402 | <dt><a name="EXTRA_DIST"><tt>EXTRA_DIST</tt></a></dt> |
| 403 | <dd>Specifies additional files that should be distributed with LLVM. All |
| 404 | source files, all built sources, all Makefiles, and most documentation files |
| 405 | will be automatically distributed. Use this variable to distribute any |
| 406 | files that are not automatically distributed.</dd> |
| 407 | <dt><a name="KEEP_SYMBOLS"><tt>KEEP_SYMBOLS</tt></a></dt> |
| 408 | <dd>If set to any value, specifies that when linking executables the |
| 409 | makefiles should retain debug symbols in the executable. Normally, symbols |
| 410 | are stripped from the executable.</dd> |
| 411 | <dt><a name="LEVEL"><tt>LEVEL</tt></a><small>(required)</dt> |
| 412 | <dd>Specify the level of nesting from the top level. This variable must be |
| 413 | set in each makefile as it is used to find the top level and thus the other |
| 414 | makefiles.</dd> |
| 415 | <dt><a name="LIBRARYNAME"><tt>LIBRARYNAME</tt></a></dt> |
| 416 | <dd>Specify the name of the library to be built. (Required For Libraries)</dd> |
| 417 | <a href="#BUILD_OBJ_DIR"><tt>BUILD_OBJ_DIR<tt></a> directory.</dd> |
| 418 | <dt><a name="LLVMLIBS"><tt>LLVMLIBS</tt></a></dt> |
| 419 | <dd>Specifies the set of libraries from the LLVM $(ObjDir) that will be |
| 420 | linked into the tool or library.</dd> |
| 421 | <dt><a name="OPTIONAL_DIRS"><tt>OPTIONAL_DIRS</tt></a></dt> |
| 422 | <dd>Specify a set of directories that may be built, if they exist, but its |
| 423 | not an error for them not to exist.</dd> |
| 424 | <dt><a name="PARALLEL_DIRS"><tt>PARALLEL_DIRS</tt></a></dt> |
| 425 | <dd>Specify a set of directories to build recursively and in parallel if |
| 426 | the -j option was used with <tt>make</tt>.</dd> |
| 427 | <dt><a name="SHARED_LIBRARY"><tt>SHARED_LIBRARY</tt></a></dt> |
| 428 | <dd>If set to any value, causes a shared library (.so) to be built in |
| 429 | addition to any other kinds of libraries. Note that this option will cause |
| 430 | all source files to be built twice: once with options for position |
| 431 | independent code and once without. Use it only where you really need a |
| 432 | shared library.</dd> |
| 433 | <dt><a name="SOURCES"><tt>SOURCES</tt><small>(optional)</small></a></td> |
| 434 | <dd>Specifies the list of source files in the current directory to be |
| 435 | built. Source files of any type may be specified (programs, documentation, |
| 436 | config files, etc.). If not specified, the makefile system will infer the |
| 437 | set of source files from the files present in the current directory.</dd> |
| 438 | <dt><a name="SUFFIXES"><tt>SUFFIXES</tt></a></dt> |
| 439 | <dd>Specifies a set of filename suffixes that occur in suffix match rules. |
| 440 | Only set this if your local <tt>Makefile</tt> specifies additional suffix |
| 441 | match rules.</dd> |
| 442 | <dt><a name="TARGET"><tt>TARGET</tt></a></dt> |
| 443 | <dd>Specifies the name of the LLVM code generation target that the |
| 444 | current directory builds. Setting this variable enables additional rules to |
| 445 | build <tt>.inc</tt> files from <tt>.td</tt> files. </dd> |
| 446 | <dt><a name="TOOLNAME"><tt>TOOLNAME</tt></a></dt> |
| 447 | <dd>Specifies the name of the tool that the current directory should |
| 448 | build.</dd> |
| 449 | <dt><a name="USEDLIBS"><tt>USEDLIBS</tt></a></td> |
| 450 | <dd>Specifies the list of project libraries that will be linked into the |
| 451 | tool or library.</dd> |
| 452 | <dt><a name="VERBOSE"><tt>VERBOSE</tt></a></td> |
| 453 | <dd>Tells the Makefile system to produce detailed output of what it is doing |
| 454 | instead of just summary comments. This will generate a LOT of output.</dd> |
| 455 | </dl> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 456 | </div> |
| 457 | |
| 458 | <!-- ======================================================================= --> |
| 459 | <div class="doc_subsection"><a name="overvars">Overridable Variables</a></div> |
| 460 | <div class="doc_text"> |
Reid Spencer | a79e58c | 2004-10-30 21:39:42 +0000 | [diff] [blame] | 461 | <p>Overridable variables can be used to override the default |
| 462 | values provided by the LLVM makefile system. These variables can be set in |
| 463 | several ways:</p> |
| 464 | <ul> |
| 465 | <li>In the environment (e.g. setenv, export) -- not recommended.</li> |
| 466 | <li>On the <tt>make</tt> command line -- recommended.</li> |
| 467 | <li>On the <tt>configure</tt> command line</li> |
| 468 | <li>In the Makefile (only <em>after</em> the inclusion of <a |
| 469 | href="Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.</li> |
| 470 | </ul> |
| 471 | <p>The overridable variables are given below:</p> |
| 472 | <dl> |
| 473 | <dt><a name="AR"><tt>AR</tt></a> <small>(defaulted)</small></dt> |
| 474 | <dd>Specifies the path to the <tt>ar</tt> tool.</dd> |
| 475 | <dt><a name="BISON"><tt>BISON</tt></a><small>(configured)</small></dt> |
| 476 | <dd>Specifies the path to the <tt>bison</tt> tool.</dd> |
| 477 | <dt><a name="BUILD_OBJ_DIR"><tt>BUILD_OBJ_DIR</tt></a></dt> |
| 478 | <dd>The directory into which the products of build rules will be placed. |
| 479 | This might be the same as |
| 480 | <a href="#BUILD_SRC_DIR"><tt>BUILD_SRC_DIR</tt></a> but typically is |
| 481 | not.</dd> |
| 482 | <dt><a name="BUILD_SRC_DIR"><tt>BUILD_SRC_DIR</tt></a></dt> |
| 483 | <dd>The directory which contains the source files to be built.</dd> |
| 484 | <dt><a name="BURG"><tt>BURG</tt></a></dt> |
| 485 | <dd>Specifies the path to the <tt>burg</tt> tool.</dd> |
| 486 | <dt><a name="BZIP2"><tt>BZIP2</tt></a><small>(configured)</small></dt> |
| 487 | <dd>The path to the <tt>bzip2</tt> tool.</dd> |
| 488 | <dt><a name="CC"><tt>CC</tt></a><small>(configured)</small></dt> |
| 489 | <dd>The path to the 'C' compiler.</dd> |
| 490 | <dt><a name="CFLAGS"><tt>CFLAGS</tt></a></dt> |
| 491 | <dd>Additional flags to be passed to the 'C' compiler.</dd> |
| 492 | <dt><a name="CXX"><tt>CXX</tt></a></dt> |
| 493 | <dd>Specifies the path to the C++ compiler.</dd> |
| 494 | <dt><a name="CXXFLAGS"><tt>CXXFLAGS</tt></a></dt> |
| 495 | <dd>Additional flags to be passed to the C++ compiler.</dd> |
| 496 | <dt><a name="DATE"><tt>DATE<small>(configured)</small></tt></a></dt> |
| 497 | <dd>Specifies the path to the <tt>date</tt> program or any program that can |
| 498 | generate the current date and time on its standard output</dd> |
| 499 | <dt><a name="DOT"><tt>DOT</tt></a><small>(configured)</small></dt> |
| 500 | <dd>Specifies the path to the <tt>dot</tt> tool or <tt>false</tt> if there |
| 501 | isn't one.</dd> |
| 502 | <dt><a name="ECHO"><tt>ECHO</tt></a><small>(configured)</small></dt> |
| 503 | <dd>Specifies the path to the <tt>echo</tt> tool for printing output.</dd> |
| 504 | <dt><a name="ETAGS"><tt>ETAGS</tt></a><small>(configured)</small></dt> |
| 505 | <dd>Specifies the path to the <tt>etags</tt> tool.</dd> |
| 506 | <dt><a name="ETAGSFLAGS"><tt>ETAGSFLAGS</tt></a><small>(configured)</small></dt> |
| 507 | <dd>Provides flags to be passed to the <tt>etags</tt> tool.</dd> |
| 508 | <dt><a name="EXEEXT"><tt>EXEEXT</tt></a><small>(configured)</small></dt> |
| 509 | <dd>Provides the extension to be used on executables built by the makefiles. |
| 510 | The value may be empty on platforms that do not use file extensions for |
| 511 | executables (e.g. Unix).</dd> |
| 512 | <dt><a name="FLEX"><tt>FLEX</tt></a><small>(configured)</small></dt> |
| 513 | <dd>Specifies the path to the <tt>flex</tt> tool.</dd> |
| 514 | <dt><a name="GCCLD"><tt>GCCLD</tt></a><small>(defaulted)</small></dt> |
| 515 | <dd>Specifies the path to the <tt>gccld</tt> tool.</dd> |
| 516 | <dt><a name="HAVE_BZIP2"><tt>HAVE_BZIP2</tt></a><small>(configured)</small></dt> |
| 517 | <dd>This variable is set automatically if the <tt>configure</tt> script |
| 518 | could find the bzip2 library.</dd> |
| 519 | <dt><a name="HAVE_ZLIB"><tt>HAVE_ZLIB</tt></a><small>(configured)</small></dt> |
| 520 | <dd>This variable is set automatically if the <tt>configure</tt> script |
| 521 | could find the zlib library.</dd> |
| 522 | <dt><a name="INSTALL"><tt>INSTALL</tt></a><small>(configured)</small></dt> |
| 523 | <dd>Specifies the path to the <tt>install</tt> tool.</dd> |
| 524 | <dt><a name="LDFLAGS"><tt>LDFLAGS</tt></a><small>(configured)</small></dt> |
| 525 | <dd>Allows users to specify additional flags to pass to the linker.</dd> |
| 526 | <dt><a name="LIBS"><tt>LIBS</tt></a><small>(configured)</small></dt> |
| 527 | <dd>The list of libraries that should be linked with each tool.</dd> |
| 528 | <dt><a name="LIBTOOL"><tt>LIBTOOL</tt></a><small>(configured)</small></dt> |
| 529 | <dd>Specifies the path to the <tt>libtool</tt> tool. This tool is renamed |
| 530 | <tt>mklib</tt> by the <tt>configure</tt> script and always located in the |
| 531 | <dt><a name="LLVMAS"><tt>LLVMAS</tt></a><small>(defaulted)</small></dt> |
| 532 | <dd>Specifies the path to the <tt>llvm-as</tt> tool.</dd> |
| 533 | <dt><a name="LLVMGCC"><tt>LLVMGCC</tt></a><small>(defaulted)</small></dt> |
| 534 | <dd>Specifies the path to the LLVM version of the GCC 'C' Compiler</dd> |
| 535 | <dt><a name="LLVMGXX"><tt>LLVMGXX</tt></a><small>(defaulted)</small></dt> |
| 536 | <dd>Specifies the path to the LLVM version of the GCC C++ Compiler</dd> |
| 537 | <dt><a name="LLVM_OBJ_ROOT"><tt>LLVM_OBJ_ROOT</tt></a><small>(configured)</small></dt> |
| 538 | <dd>Specifies the top directory into which the output of the build is |
| 539 | placed.</dd> |
| 540 | <dt><a name="LLVM_SRC_ROOT"><tt>LLVM_SRC_ROOT</tt></a><small>(configured)</small></dt> |
| 541 | <dd>Specifies the top directory in which the sources are found.</dd> |
| 542 | <dt><a name="LLVM_TARBALL_NAME"><tt>LLVM_TARBALL_NAME</tt></a><small>(configured)</small></dt> |
| 543 | <dd>Specifies the name of the distribution tarball to create. This is |
| 544 | configured from the name of the project and its version number.</dd> |
| 545 | <dt><a name="MKDIR"><tt>MKDIR</tt></a><small>(defaulted)</small></dt> |
| 546 | <dd>Specifies the path to the <tt>mkdir</tt> tool that creates |
| 547 | directories.</dd> |
| 548 | <dt><a name="PLATFORMSTRIPOPTS"><tt>PLATFORMSTRIPOPTS</tt></a></dt> |
| 549 | <dd>The options to provide to the linker to specify that a stripped (no |
| 550 | symbols) executable should be built.</dd> |
| 551 | <dt><a name="RANLIB"><tt>RANLIB</tt></a><small>(defaulted)</small></dt> |
| 552 | <dd>Specifies the path to the <tt>ranlib</tt> tool.</dd> |
| 553 | <dt><a name="RM"><tt>RM</tt></a><small>(defaulted)</small></dt> |
| 554 | <dd>Specifies the path to the <tt>rm</tt> tool.</dd> |
| 555 | <dt><a name="SED"><tt>SED</tt></a><small>(defaulted)</small></dt> |
| 556 | <dd>Specifies the path to the <tt>sed</tt> tool.</dd> |
| 557 | <dt><a name="SHLIBEXT"><tt>SHLIBEXT</tt></a><small>(configured)</small></dt> |
| 558 | <dd>Provides the filename extension to use for shared libraries.</dd> |
| 559 | <dt><a name="TBLGEN"><tt>TBLGEN</tt></a><small>(defaulted)</small></dt> |
| 560 | <dd>Specifies the path to the <tt>tblgen</tt> tool.</dd> |
| 561 | <dt><a name="TAR"><tt>TAR</tt></a><small>(defaulted)</small></dt> |
| 562 | <dd>Specifies the path to the <tt>tar</tt> tool.</dd> |
| 563 | <dt><a name="ZIP"><tt>ZIP</tt></a><small>(defaulted)</small></dt> |
| 564 | <dd>Specifies the path to the <tt>zip</tt> tool.</dd> |
| 565 | </dl> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 566 | </div> |
| 567 | |
| 568 | <!-- ======================================================================= --> |
| 569 | <div class="doc_subsection"><a name="getvars">Readable Variables</a></div> |
| 570 | <div class="doc_text"> |
| 571 | <p>Variables listed in the table below can be used by the user's Makefile but |
| 572 | should not be changed. Changing the value will generally cause the build to go |
| 573 | wrong, so don't do it.</p> |
Reid Spencer | a79e58c | 2004-10-30 21:39:42 +0000 | [diff] [blame] | 574 | <dl> |
| 575 | <dt><a name="bindir"><tt>bindir</tt></a></dt> |
| 576 | <dd>The directory into which executables will ultimately be installed. This |
| 577 | value is derived from the <tt>--prefix</tt> option given to |
| 578 | <tt>configure</tt>.</dd> |
| 579 | <dt><a name="bytecode_libdir"><tt>bytecode_libdir</tt></a></dt> |
| 580 | <dd>The directory into which bytecode libraries will ultimately be installed. |
| 581 | This value is derived from the <tt>--prefix</tt> option given to |
| 582 | <tt>configure</tt>.</dd> |
| 583 | <dt><a name="ConfigureScriptFLAGS"><tt>ConfigureScriptFLAGS</tt></a></dt> |
| 584 | <dd>Additional flags given to the <tt>configure</tt> script when |
| 585 | reconfiguring.</dd> |
| 586 | <dt><a name="DistDir"><tt>DistDir</tt></a></dt> |
| 587 | <dd>The <em>current</em> directory for which a distribution copy is being |
| 588 | made.</dd> |
| 589 | <dt><a name="Echo"><tt>Echo</tt></a></dt> |
| 590 | <dd>The LLVM Makefile System output command. This provides the |
| 591 | <tt>llvm[n]</tt> prefix and starts with @ so the command itself is not |
| 592 | printed by <tt>make</tt>.</dd> |
| 593 | <dt><a name="EchoCmd"><tt>EchoCmd</tt></a></dt> |
| 594 | <dd> Same as <a href="#Echo"><tt>Echo</tt></a> but without the leading @. |
| 595 | </dd> |
| 596 | <dt><a name="includedir"><tt>includedir</tt></a></dt> |
| 597 | <dd>The directory into which include files will ultimately be installed. |
| 598 | This value is derived from the <tt>--prefix</tt> option given to |
| 599 | <tt>configure</tt>.</dd> |
| 600 | <dt><a name="libdir"><tt>libdir</tt></a></dt><dd></dd> |
| 601 | <dd>The directory into which native libraries will ultimately be installed. |
| 602 | This value is derived from the <tt>--prefix</tt> option given to |
| 603 | <tt>configure</tt>.</dd> |
| 604 | <dt><a name="LibDir"><tt>LibDir</tt></a></dt> |
| 605 | <dd>The configuration specific directory into which libraries are placed |
| 606 | before installation.</dd> |
| 607 | <dt><a name="MakefileConfig"><tt>MakefileConfig</tt></a></dt> |
| 608 | <dd>Full path of the <tt>Makefile.config</tt> file.</dd> |
| 609 | <dt><a name="MakefileConfigIn"><tt>MakefileConfigIn</tt></a></dt> |
| 610 | <dd>Full path of the <tt>Makefile.config.in</tt> file.</dd> |
| 611 | <dt><a name="ObjDir"><tt>ObjDir</tt></a></dt> |
| 612 | <dd>The configuration and directory specific directory where build objects |
| 613 | (compilation results) are placed.</dd> |
| 614 | <dt><a name="SubDirs"><tt>SubDirs</tt></a></dt> |
| 615 | <dd>The complete list of sub-directories of the current directory as |
| 616 | specified by other variables.</dd> |
| 617 | <dt><a name="Sources"><tt>Sources</tt></a></dt> |
| 618 | <dd>The complete list of source files.</dd> |
| 619 | <dt><a name="sysconfdir"><tt>sysconfdir</tt></a></dt> |
| 620 | <dd>The directory into which configuration files will ulitmately be |
| 621 | installed. This value is derived from the <tt>--prefix</tt> option given to |
| 622 | <tt>configure</tt>.</dd> |
| 623 | <dt><a name="ToolDir"><tt>ToolDir</tt></a></dt> |
| 624 | <dd>The configuration specific directory into which executables are placed |
| 625 | before they are installed.</dd> |
| 626 | <dt><a name="TopDistDir"><tt>TopDistDir</tt></a></dt> |
| 627 | <dd>The top most directory into which the distribution files are copied.</dd> |
| 628 | <dt><a name="Verb"><tt>Verb</tt></a></dt> |
| 629 | <dd>Use this as the first thing on your build script lines to enable or |
| 630 | disable verbose mode. It expands to either an @ (quiet mode) or nothing |
| 631 | (verbose mode). </dd> |
| 632 | </dl> |
| 633 | </div> |
| 634 | |
| 635 | <!-- ======================================================================= --> |
| 636 | <div class="doc_subsection"><a name="intvars">Internal Variables</a></div> |
| 637 | <div class="doc_text"> |
| 638 | <p>Variables listed below are used by the LLVM Makefile System |
| 639 | and considered internal. You should not use these variables under any |
| 640 | circumstances.</p> |
| 641 | <dl> |
| 642 | <dt><a name="Archive"><tt>Archive</tt></a></dt><dd></dd> |
| 643 | <dt><a name="AR.Flags"><tt>AR.Flags</tt></a></dt><dd></dd> |
| 644 | <dt><a name="BaseNameSources"><tt>BaseNameSources</tt></a></dt><dd></dd> |
| 645 | <dt><a name="BCCompile.C"><tt>BCCompile.C</tt></a></dt><dd></dd> |
| 646 | <dt><a name="BCCompile.CXX"><tt>BCCompile.CXX</tt></a></dt><dd></dd> |
| 647 | <dt><a name="BCLinkLib"><tt>BCLinkLib</tt></a></dt><dd></dd> |
| 648 | <dt><a name="Burg"><tt>Burg</tt></a></dt><dd></dd> |
| 649 | <dt><a name="C.Flags"><tt>C.Flags</tt></a></dt><dd></dd> |
| 650 | <dt><a name="Compile.C"><tt>Compile.C</tt></a></dt><dd></dd> |
| 651 | <dt><a name="CompileCommonOpts"><tt>CompileCommonOpts</tt></a></dt><dd></dd> |
| 652 | <dt><a name="Compile.CXX"><tt>Compile.CXX</tt></a></dt><dd></dd> |
| 653 | <dt><a name="ConfigStatusScript"><tt>ConfigStatusScript</tt></a></dt><dd></dd> |
| 654 | <dt><a name="Configuration"><tt>Configuration</tt></a></dt><dd></dd> |
| 655 | <dt><a name="ConfigureScript"><tt>ConfigureScript</tt></a></dt><dd></dd> |
| 656 | <dt><a name="CPP.Flags"><tt>CPP.Flags</tt></a></dt><dd></dd> |
| 657 | <dt><a name="CPP.Flags "><tt>CPP.Flags </tt></a></dt><dd></dd> |
| 658 | <dt><a name="CXX.Flags"><tt>CXX.Flags</tt></a></dt><dd></dd> |
| 659 | <dt><a name="DependFiles"><tt>DependFiles</tt></a></dt><dd></dd> |
| 660 | <dt><a name="DestArchiveLib"><tt>DestArchiveLib</tt></a></dt><dd></dd> |
| 661 | <dt><a name="DestBytecodeLib"><tt>DestBytecodeLib</tt></a></dt><dd></dd> |
| 662 | <dt><a name="DestRelinkedLib"><tt>DestRelinkedLib</tt></a></dt><dd></dd> |
| 663 | <dt><a name="DestSharedLib"><tt>DestSharedLib</tt></a></dt><dd></dd> |
| 664 | <dt><a name="DestTool"><tt>DestTool</tt></a></dt><dd></dd> |
| 665 | <dt><a name="DistAlways"><tt>DistAlways</tt></a></dt><dd></dd> |
| 666 | <dt><a name="DistCheckDir"><tt>DistCheckDir</tt></a></dt><dd></dd> |
| 667 | <dt><a name="DistCheckTop"><tt>DistCheckTop</tt></a></dt><dd></dd> |
| 668 | <dt><a name="DistFiles"><tt>DistFiles</tt></a></dt><dd></dd> |
| 669 | <dt><a name="DistName"><tt>DistName</tt></a></dt><dd></dd> |
| 670 | <dt><a name="DistOther"><tt>DistOther</tt></a></dt><dd></dd> |
| 671 | <dt><a name="DistSources"><tt>DistSources</tt></a></dt><dd></dd> |
| 672 | <dt><a name="DistSubDirs"><tt>DistSubDirs</tt></a></dt><dd></dd> |
| 673 | <dt><a name="DistTarBZ2"><tt>DistTarBZ2</tt></a></dt><dd></dd> |
| 674 | <dt><a name="DistTarGZip"><tt>DistTarGZip</tt></a></dt><dd></dd> |
| 675 | <dt><a name="DistZip"><tt>DistZip</tt></a></dt><dd></dd> |
| 676 | <dt><a name="ExtraLibs"><tt>ExtraLibs</tt></a></dt><dd></dd> |
| 677 | <dt><a name="INCFiles"><tt>INCFiles</tt></a></dt><dd></dd> |
| 678 | <dt><a name="InternalTargets"><tt>InternalTargets</tt></a></dt><dd></dd> |
| 679 | <dt><a name="LD.Flags"><tt>LD.Flags</tt></a></dt><dd></dd> |
| 680 | <dt><a name="LexOutput"><tt>LexOutput</tt></a></dt><dd></dd> |
| 681 | <dt><a name="LibName.A"><tt>LibName.A</tt></a></dt><dd></dd> |
| 682 | <dt><a name="LibName.BC"><tt>LibName.BC</tt></a></dt><dd></dd> |
| 683 | <dt><a name="LibName.LA"><tt>LibName.LA</tt></a></dt><dd></dd> |
| 684 | <dt><a name="LibName.O"><tt>LibName.O</tt></a></dt><dd></dd> |
| 685 | <dt><a name="LibTool.Flags"><tt>LibTool.Flags</tt></a></dt><dd></dd> |
| 686 | <dt><a name="Link"><tt>Link</tt></a></dt><dd></dd> |
| 687 | <dt><a name="LLVMGCCLibDir"><tt>LLVMGCCLibDir</tt></a></dt><dd></dd> |
| 688 | <dt><a name="LLVMLibDir"><tt>LLVMLibDir</tt></a></dt><dd></dd> |
| 689 | <dt><a name="LLVMLibsOptions"><tt>LLVMLibsOptions</tt></a></dt><dd></dd> |
| 690 | <dt><a name="LLVMLibsPaths"><tt>LLVMLibsPaths</tt></a></dt><dd></dd> |
| 691 | <dt><a name="LLVMToolDir"><tt>LLVMToolDir</tt></a></dt><dd></dd> |
| 692 | <dt><a name="LLVMUsedLibs"><tt>LLVMUsedLibs</tt></a></dt><dd></dd> |
| 693 | <dt><a name="LocalTargets"><tt>LocalTargets</tt></a></dt><dd></dd> |
| 694 | <dt><a name="LTCompile.C"><tt>LTCompile.C</tt></a></dt><dd></dd> |
| 695 | <dt><a name="LTCompile.CXX"><tt>LTCompile.CXX</tt></a></dt><dd></dd> |
| 696 | <dt><a name="LTInstall"><tt>LTInstall</tt></a></dt><dd></dd> |
| 697 | <dt><a name="ObjectsBC"><tt>ObjectsBC</tt></a></dt><dd></dd> |
| 698 | <dt><a name="ObjectsLO"><tt>ObjectsLO</tt></a></dt><dd></dd> |
| 699 | <dt><a name="ObjectsO"><tt>ObjectsO</tt></a></dt><dd></dd> |
| 700 | <dt><a name="ObjMakefiles"><tt>ObjMakefiles</tt></a></dt><dd></dd> |
| 701 | <dt><a name="Parallel_Targets"><tt>Parallel_Targets</tt></a></dt><dd></dd> |
| 702 | <dt><a name="PreConditions"><tt>PreConditions</tt></a></dt><dd></dd> |
| 703 | <dt><a name="ProjLibsOptions"><tt>ProjLibsOptions</tt></a></dt><dd></dd> |
| 704 | <dt><a name="ProjLibsPaths"><tt>ProjLibsPaths</tt></a></dt><dd></dd> |
| 705 | <dt><a name="ProjUsedLibs"><tt>ProjUsedLibs</tt></a></dt><dd></dd> |
| 706 | <dt><a name="Ranlib"><tt>Ranlib</tt></a></dt><dd></dd> |
| 707 | <dt><a name="RecursiveTargets"><tt>RecursiveTargets</tt></a></dt><dd></dd> |
| 708 | <dt><a name="Relink"><tt>Relink</tt></a></dt><dd></dd> |
| 709 | <dt><a name="SrcMakefiles"><tt>SrcMakefiles</tt></a></dt><dd></dd> |
| 710 | <dt><a name="Strip"><tt>Strip</tt></a></dt><dd></dd> |
| 711 | <dt><a name="StripWarnMsg"><tt>StripWarnMsg</tt></a></dt><dd></dd> |
| 712 | <dt><a name="TableGen"><tt>TableGen</tt></a></dt><dd></dd> |
| 713 | <dt><a name="TDFiles"><tt>TDFiles</tt></a></dt><dd></dd> |
| 714 | <dt><a name="ToolBuildPath"><tt>ToolBuildPath</tt></a></dt><dd></dd> |
| 715 | <dt><a name="TopLevelTargets"><tt>TopLevelTargets</tt></a></dt><dd></dd> |
| 716 | <dt><a name="UserTargets"><tt>UserTargets</tt></a></dt><dd></dd> |
| 717 | <dt><a name="YaccOutput"><tt>YaccOutput</tt></a></dt><dd></dd> |
| 718 | </dl> |
Reid Spencer | 504b21a | 2004-10-23 07:57:22 +0000 | [diff] [blame] | 719 | </div> |
| 720 | |
| 721 | <!-- *********************************************************************** --> |
| 722 | <hr> |
| 723 | <address> |
| 724 | <a href="http://jigsaw.w3.org/css-validator/check/referer"><img |
| 725 | src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a> |
| 726 | <a href="http://validator.w3.org/check/referer"><img |
| 727 | src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a> |
| 728 | |
| 729 | <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br> |
| 730 | <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br> |
| 731 | Last modified: $Date$ |
| 732 | </address> |
| 733 | |
| 734 | </body> |
| 735 | </html> |
| 736 | <!-- vim: sw=2 noai |
| 737 | --> |