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