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