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