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