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