[llvm-commits] CVS: llvm/docs/MakefileGuide.html
Reid Spencer
reid at x10sys.com
Sat Oct 30 14:39:53 PDT 2004
Changes in directory llvm/docs:
MakefileGuide.html updated: 1.4 -> 1.5
---
Log message:
Complete the description of public variables. Internal variables are listed
but not described. It might just stay that way.
---
Diffs of the changes: (+358 -136)
Index: llvm/docs/MakefileGuide.html
diff -u llvm/docs/MakefileGuide.html:1.4 llvm/docs/MakefileGuide.html:1.5
--- llvm/docs/MakefileGuide.html:1.4 Mon Oct 25 14:37:46 2004
+++ llvm/docs/MakefileGuide.html Sat Oct 30 16:39:42 2004
@@ -43,6 +43,7 @@
<li><a href="#setvars">Control Variables</a></li>
<li><a href="#overvars">Override Variables</a></li>
<li><a href="#getvars">Readable Variables</a></li>
+ <li><a href="#intvars">Internal Variables</a></li>
</ol>
</li>
</ol>
@@ -51,8 +52,6 @@
<p>Written by <a href="mailto:reid at x10sys.com">Reid Spencer</a></p>
</div>
-<div class="doc_warning"><p>WARNING: This document is a work in progress!</p></div>
-
<!-- *********************************************************************** -->
<div class="doc_section"><a name="introduction">Introduction </a></div>
<!-- *********************************************************************** -->
@@ -207,6 +206,9 @@
<tr><td><a href="#install"><tt>install</tt></a></td><td>all</td>
<td>Copy built objects to installation directory.
</td></tr>
+ <tr><td><a href="#printvars"><tt>printvars</tt></a></td><td>all</td>
+ <td>Prints variables defined by the makefile system (for debugging).
+ </td></tr>
<tr><td><a href="#tags"><tt>tags</tt></a></td><td></td>
<td>Make C and C++ tags files for emacs and vi.
</td></tr>
@@ -247,7 +249,6 @@
0 then the check succeeds, otherwise not. The programs run can be anything but
they should either be local to the directory or in your path.</p>
</div>
-<div class="doc_warning"><p>Not implemented yet!</p></div>
<!-- ======================================================================= -->
<div class="doc_subsection"><a name="check-local">check-local</a></div>
@@ -255,7 +256,6 @@
<p>This target does the same thing as <tt>check</tt> but only for the current
(local) directory.</p>
</div>
-<div class="doc_warning"><p>Not implemented yet!</p></div>
<!-- ======================================================================= -->
<div class="doc_subsection"><a name="clean">clean</a></div>
@@ -280,7 +280,6 @@
compresses it. The generated tarball is sufficient for a casual source
distribution, but probably not for a release (see <tt>dist-check</tt>).</p>
</div>
-<div class="doc_warning"><p>Not implemented yet!</p></div>
<!-- ======================================================================= -->
<div class="doc_subsection"><a name="dist-check">dist-check</a></div>
@@ -293,7 +292,6 @@
goes out to make sure that the distributed tarball can actually be built into
a working release.</p>
</div>
-<div class="doc_warning"><p>Not implemented yet!</p></div>
<!-- ======================================================================= -->
<div class="doc_subsection"><a name="dist-clean">dist-clean</a></div>
@@ -302,7 +300,6 @@
normal <tt>clean</tt> but also removes things pertaining to building the
distribution.</p>
</div>
-<div class="doc_warning"><p>Not implemented yet!</p></div>
<!-- ======================================================================= -->
<div class="doc_subsection"><a name="install">install</a></div>
@@ -343,7 +340,11 @@
<!-- *********************************************************************** -->
<div class="doc_text">
<p>Variables are used to tell the LLVM Makefile System what to do and to
- obtain information from it. The sections below describe the three kinds of
+ obtain information from it. Variables are also used internally by the LLVM
+ Makefile System. Variable names that contain only the upper case alphabetic
+ letters and underscore are intended for use by the end user. All other
+ variables are internal to the LLVM Makefile System and should not be relied
+ upon nor modified. The sections below describe how to use the LLVM Makefile
variables.</p>
</div>
@@ -354,98 +355,214 @@
inclusion of <a href="Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.
These variables provide input to the LLVM make system that tell it what to do
for the current directory.</p>
- <table style="text-align:left">
- <tr><th>Variable Name</th><th>Variable Description</th></tr>
- <tr>
- <td><a href="#BUILD_ARCHIVE"><tt>BUILD_ARCHIVE</tt></a></td>
- <td>If set to any value, causes an archive (.a) library to be built.</td>
- </tr><tr><td><a href="#BUILT_SOURCES"><tt>BUILT_SOURCES</tt></a></td>
- <td>Specifies a set of source files that are generated. These will be
- built before any other target processing to ensure they are present.</td>
- </tr><tr><td><a href="#BYTECODE_LIBRARY"><tt>BUILT_SOURCES</tt></a></td>
- <td>If set to any value, causes a bytecode library (.bc) to be built.</td>
- </tr><tr><td><a href="#CONFIG_FILES"><tt>BUILT_SOURCES</tt></a></td>
- <td>Specifies a set of configuration files to be installed.</td>
- </tr><tr><td><a href="#DIRS"><tt>DIRS</tt></a></td>
- <td>Specifies a set of directories that should also be made using the
- same goal. These directories will be built serially.</td>
- </tr><tr><td><a href="#DONT_BUILD_RELINKED"><tt>DONT_BUILD_RELINKED</tt></a></td>
- <td>If set to any value, causes a relinked library (.o) not to be built.</td>
- </tr><tr><td><a href="#EXPORTED_SYMBOL_FILE"><tt>EXPORTED_SYMBOL_FILE</tt></a></td>
- <td>Specifies the name of a single file that contains a list of the
- symbols to be exported by the linker. One symbol per line.</td>
- </tr><tr><td><a href="#LEVEL"><tt>LEVEL</tt></a></td>
- <td>Specify the level of nesting from the top level. (Required)</td>
- </tr><tr><td><a href="#LIBRARYNAME"><tt>LIBRARYNAME</tt></a></td>
- <td>Specify the name of the library to be built. (Required For Libraries)</td>
- </tr><tr><td><a href="#LLVMLIBS"><tt>LLVMLIBS</tt></a></td>
- <td>Specify the set of libraries from the LLVM $(OBJDIR) that will be
- linked into the tool or library.</td>
- </tr><tr><td><a href="#EXPERIMENTAL_DIRS"><tt>EXPERIMENTAL_DIRS</tt></a></td>
- <td>Specify a set of directories that should be built, but if they fail,
- it should not cause the build to fail. Note that this should only be
- used temporarily while code is being written.</td>
- </tr><tr><td><a href="#OPTIONAL_DIRS"><tt>OPTIONAL_DIRS</tt></a></td>
- <td>Specify a set of directories that may be built, if they exist, but its
- not an error for them not to exist.</td>
- </tr><tr><td><a href="#PARALLEL_DIRS"><tt>PARALLEL_DIRS</tt></a></td>
- <td>Specify a set of directories to build recursively and in parallel if
- the -j option was used with <tt>make</tt>.</td>
- </tr><tr><td><a href="#SHARED_LIBRARY"><tt>SHARED_LIBRARY</tt></a></td>
- <td>If set to any value, causes a shared library (.so) to be built.
- (Optional)</td>
- </tr><tr><td><a href="#SOURCES"><tt>SOURCES</tt></a></td>
- <td>Specifies the list of source files in the current directory to be
- acted upon. Source files of any type may be specified (programs,
- documentation, config files, etc.)</td>
- </tr><tr><td><a href="#TARGET"><tt>TARGET</tt></a></td>
- <td>Specifies the name of the LLVM code generation target that the
- current directory builds.</td>
- </tr><tr><td><a href="#TOOLNAME"><tt>TOOLNAME</tt></a></td>
- <td>Specifies the name of the tool to build. (Required For Tools)</td>
- </tr><tr><td><a href="#USEDLIBS"><tt>USEDLIBS</tt></a></td>
- <td>Specifies the list of project libraries that will be linked into the
- tool or library.</td>
- </tr>
- </table>
+ <dl>
+ <dt><a name="BUILD_ARCHIVE"><tt>BUILD_ARCHIVE</tt></a></dt>
+ <dd>If set to any value, causes an archive (.a) library to be built.</dd>
+ <dt><a name="BUILT_SOURCES"><tt>BUILT_SOURCES</tt></a></dt>
+ <dd>Specifies a set of source files that are generated from other source
+ files. These sources will be built before any other target processing to
+ ensure they are present.</td>
+ <dt><a name="BYTECODE_LIBRARY"><tt>BYTECODE_LIBRARY</tt></a></dt>
+ <dd>If set to any value, causes a bytecode library (.bc) to be built.</dd>
+ <dt><a name="CONFIG_FILES"><tt>CONFIG_FILES</tt></a></dt>
+ <dd>Specifies a set of configuration files to be installed.</dd>
+ <dt><a name="DIRS"><tt>DIRS</tt></a></dt>
+ <dd>Specifies a set of directories, usually children of the current
+ directory, that should also be made using the same goal. These directories
+ will be built serially.</dd>
+ <dt><a name="DISABLE_AUTO_DEPENDENCIES"><tt>DISABLE_AUTO_DEPENDENCIES</tt></a></dt>
+ <dd>If set to any value, causes the makefiles to <b>not</b> automatically
+ generate dependencies when running the compiler. Use of this feature is
+ discouraged and it may be removed at a later date.</dd>
+ <dt><a name="DONT_BUILD_RELINKED"><tt>DONT_BUILD_RELINKED</tt></a></dt>
+ <dd>If set to any value, causes a relinked library (.o) not to be built. By
+ default, libraries are built as re-linked since most LLVM libraries are
+ needed in their entirety and re-linked libraries will be linked more quickly
+ than equival archive libraries.</dd>
+ <dt><a name="ENABLE_OPTIMIZED"><tt>ENABLE_OPTIMIZED</tt></a></dt>
+ <dd>If set to any value, causes the build to generate optimized objects,
+ libraries and executables. This alters the flags specified to the compilers
+ and linkers. Generally debugging won't be a fun experience with an optimized
+ build.</dd>
+ <dt><a name="ENABLE_PROFILING"><tt>ENABLE_PROFILING</tt></a></dt>
+ <dd>If set to any value, causes the build to generate both optimized and
+ profiled objects, libraries and executables. This alters the flags specified
+ to the compilers and linkers to ensure that profile data can be collected
+ from the tools built. Use the <tt>gprof</tt> tool to analyze the output from
+ the profiled tools (<tt>gmon.out</tt>).</dd>
+ <dt><a name="EXPERIMENTAL_DIRS"><tt>EXPERIMENTAL_DIRS</tt></a></dt>
+ <dd>Specify a set of directories that should be built, but if they fail, it
+ should not cause the build to fail. Note that this should only be used
+ temporarily while code is being written.</dd>
+ <dt><a name="EXPORTED_SYMBOL_FILE"><tt>EXPORTED_SYMBOL_FILE</tt></a></dt>
+ <dd>Specifies the name of a single file that contains a list of the
+ symbols to be exported by the linker. One symbol per line.</dd>
+ <dt><a name="EXPORTED_SYMBOL_LIST"><tt>EXPORTED_SYMBOL_LIST</tt></a></dt>
+ <dd>Specifies a set of symbols to be exported by the linker.</dd>
+ <dt><a name="EXTRA_DIST"><tt>EXTRA_DIST</tt></a></dt>
+ <dd>Specifies additional files that should be distributed with LLVM. All
+ source files, all built sources, all Makefiles, and most documentation files
+ will be automatically distributed. Use this variable to distribute any
+ files that are not automatically distributed.</dd>
+ <dt><a name="KEEP_SYMBOLS"><tt>KEEP_SYMBOLS</tt></a></dt>
+ <dd>If set to any value, specifies that when linking executables the
+ makefiles should retain debug symbols in the executable. Normally, symbols
+ are stripped from the executable.</dd>
+ <dt><a name="LEVEL"><tt>LEVEL</tt></a><small>(required)</dt>
+ <dd>Specify the level of nesting from the top level. This variable must be
+ set in each makefile as it is used to find the top level and thus the other
+ makefiles.</dd>
+ <dt><a name="LIBRARYNAME"><tt>LIBRARYNAME</tt></a></dt>
+ <dd>Specify the name of the library to be built. (Required For Libraries)</dd>
+ <a href="#BUILD_OBJ_DIR"><tt>BUILD_OBJ_DIR<tt></a> directory.</dd>
+ <dt><a name="LLVMLIBS"><tt>LLVMLIBS</tt></a></dt>
+ <dd>Specifies the set of libraries from the LLVM $(ObjDir) that will be
+ linked into the tool or library.</dd>
+ <dt><a name="OPTIONAL_DIRS"><tt>OPTIONAL_DIRS</tt></a></dt>
+ <dd>Specify a set of directories that may be built, if they exist, but its
+ not an error for them not to exist.</dd>
+ <dt><a name="PARALLEL_DIRS"><tt>PARALLEL_DIRS</tt></a></dt>
+ <dd>Specify a set of directories to build recursively and in parallel if
+ the -j option was used with <tt>make</tt>.</dd>
+ <dt><a name="SHARED_LIBRARY"><tt>SHARED_LIBRARY</tt></a></dt>
+ <dd>If set to any value, causes a shared library (.so) to be built in
+ addition to any other kinds of libraries. Note that this option will cause
+ all source files to be built twice: once with options for position
+ independent code and once without. Use it only where you really need a
+ shared library.</dd>
+ <dt><a name="SOURCES"><tt>SOURCES</tt><small>(optional)</small></a></td>
+ <dd>Specifies the list of source files in the current directory to be
+ built. Source files of any type may be specified (programs, documentation,
+ config files, etc.). If not specified, the makefile system will infer the
+ set of source files from the files present in the current directory.</dd>
+ <dt><a name="SUFFIXES"><tt>SUFFIXES</tt></a></dt>
+ <dd>Specifies a set of filename suffixes that occur in suffix match rules.
+ Only set this if your local <tt>Makefile</tt> specifies additional suffix
+ match rules.</dd>
+ <dt><a name="TARGET"><tt>TARGET</tt></a></dt>
+ <dd>Specifies the name of the LLVM code generation target that the
+ current directory builds. Setting this variable enables additional rules to
+ build <tt>.inc</tt> files from <tt>.td</tt> files. </dd>
+ <dt><a name="TOOLNAME"><tt>TOOLNAME</tt></a></dt>
+ <dd>Specifies the name of the tool that the current directory should
+ build.</dd>
+ <dt><a name="USEDLIBS"><tt>USEDLIBS</tt></a></td>
+ <dd>Specifies the list of project libraries that will be linked into the
+ tool or library.</dd>
+ <dt><a name="VERBOSE"><tt>VERBOSE</tt></a></td>
+ <dd>Tells the Makefile system to produce detailed output of what it is doing
+ instead of just summary comments. This will generate a LOT of output.</dd>
+ </dl>
</div>
<!-- ======================================================================= -->
<div class="doc_subsection"><a name="overvars">Overridable Variables</a></div>
<div class="doc_text">
- <p>Variables listed in the table below can be used to override the default
- values provided by the LLVM makefile system. These variables should be set
- <em>after</em> the inclusion of <a
- href="Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.</p>
- <table style="text-align:left">
- <tr><th>Variable Name</th><th>Variable Description</th></tr>
- <tr>
- <td><a href="#C"><tt>C</tt></a></td>
- <td>The name (and optional path) of the 'C' compiler (gcc normally).</td>
- </tr>
- <tr>
- <td><a href="#CFLAGS"><tt>CFLAGS</tt></a></td>
- <td>The set of options to be passed to the 'C' compiler on <em>every</em>
- compile.</td>
- </tr>
- <tr>
- <td><a href="#CPP"><tt>CPP</tt></a></td>
- <td>The name (and optional path) of the 'C' pre-processor (cpp normally).
- </td>
- </tr>
- <tr>
- <td><a href="#CXX"><tt>CXX</tt></a></td>
- <td>The name (and optional path) of the C++ compiler (g++ normally).</td>
- </tr>
- <tr>
- <td><a href="#LD"><tt>LD</tt></a></td>
- <td>The name (and optional path) of the system linker (gcc normally).</td>
- </tr>
- <tr>
- <td><a href="#LIBTOOL"><tt>LIBTOOL</tt></a></td>
- <td>The name (and optional path) of the libtool tool (libtool normally).</td>
- </tr>
- </table>
+ <p>Overridable variables can be used to override the default
+ values provided by the LLVM makefile system. These variables can be set in
+ several ways:</p>
+ <ul>
+ <li>In the environment (e.g. setenv, export) -- not recommended.</li>
+ <li>On the <tt>make</tt> command line -- recommended.</li>
+ <li>On the <tt>configure</tt> command line</li>
+ <li>In the Makefile (only <em>after</em> the inclusion of <a
+ href="Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.</li>
+ </ul>
+ <p>The overridable variables are given below:</p>
+ <dl>
+ <dt><a name="AR"><tt>AR</tt></a> <small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>ar</tt> tool.</dd>
+ <dt><a name="BISON"><tt>BISON</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the path to the <tt>bison</tt> tool.</dd>
+ <dt><a name="BUILD_OBJ_DIR"><tt>BUILD_OBJ_DIR</tt></a></dt>
+ <dd>The directory into which the products of build rules will be placed.
+ This might be the same as
+ <a href="#BUILD_SRC_DIR"><tt>BUILD_SRC_DIR</tt></a> but typically is
+ not.</dd>
+ <dt><a name="BUILD_SRC_DIR"><tt>BUILD_SRC_DIR</tt></a></dt>
+ <dd>The directory which contains the source files to be built.</dd>
+ <dt><a name="BURG"><tt>BURG</tt></a></dt>
+ <dd>Specifies the path to the <tt>burg</tt> tool.</dd>
+ <dt><a name="BZIP2"><tt>BZIP2</tt></a><small>(configured)</small></dt>
+ <dd>The path to the <tt>bzip2</tt> tool.</dd>
+ <dt><a name="CC"><tt>CC</tt></a><small>(configured)</small></dt>
+ <dd>The path to the 'C' compiler.</dd>
+ <dt><a name="CFLAGS"><tt>CFLAGS</tt></a></dt>
+ <dd>Additional flags to be passed to the 'C' compiler.</dd>
+ <dt><a name="CXX"><tt>CXX</tt></a></dt>
+ <dd>Specifies the path to the C++ compiler.</dd>
+ <dt><a name="CXXFLAGS"><tt>CXXFLAGS</tt></a></dt>
+ <dd>Additional flags to be passed to the C++ compiler.</dd>
+ <dt><a name="DATE"><tt>DATE<small>(configured)</small></tt></a></dt>
+ <dd>Specifies the path to the <tt>date</tt> program or any program that can
+ generate the current date and time on its standard output</dd>
+ <dt><a name="DOT"><tt>DOT</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the path to the <tt>dot</tt> tool or <tt>false</tt> if there
+ isn't one.</dd>
+ <dt><a name="ECHO"><tt>ECHO</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the path to the <tt>echo</tt> tool for printing output.</dd>
+ <dt><a name="ETAGS"><tt>ETAGS</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the path to the <tt>etags</tt> tool.</dd>
+ <dt><a name="ETAGSFLAGS"><tt>ETAGSFLAGS</tt></a><small>(configured)</small></dt>
+ <dd>Provides flags to be passed to the <tt>etags</tt> tool.</dd>
+ <dt><a name="EXEEXT"><tt>EXEEXT</tt></a><small>(configured)</small></dt>
+ <dd>Provides the extension to be used on executables built by the makefiles.
+ The value may be empty on platforms that do not use file extensions for
+ executables (e.g. Unix).</dd>
+ <dt><a name="FLEX"><tt>FLEX</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the path to the <tt>flex</tt> tool.</dd>
+ <dt><a name="GCCLD"><tt>GCCLD</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>gccld</tt> tool.</dd>
+ <dt><a name="HAVE_BZIP2"><tt>HAVE_BZIP2</tt></a><small>(configured)</small></dt>
+ <dd>This variable is set automatically if the <tt>configure</tt> script
+ could find the bzip2 library.</dd>
+ <dt><a name="HAVE_ZLIB"><tt>HAVE_ZLIB</tt></a><small>(configured)</small></dt>
+ <dd>This variable is set automatically if the <tt>configure</tt> script
+ could find the zlib library.</dd>
+ <dt><a name="INSTALL"><tt>INSTALL</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the path to the <tt>install</tt> tool.</dd>
+ <dt><a name="LDFLAGS"><tt>LDFLAGS</tt></a><small>(configured)</small></dt>
+ <dd>Allows users to specify additional flags to pass to the linker.</dd>
+ <dt><a name="LIBS"><tt>LIBS</tt></a><small>(configured)</small></dt>
+ <dd>The list of libraries that should be linked with each tool.</dd>
+ <dt><a name="LIBTOOL"><tt>LIBTOOL</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the path to the <tt>libtool</tt> tool. This tool is renamed
+ <tt>mklib</tt> by the <tt>configure</tt> script and always located in the
+ <dt><a name="LLVMAS"><tt>LLVMAS</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>llvm-as</tt> tool.</dd>
+ <dt><a name="LLVMGCC"><tt>LLVMGCC</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the LLVM version of the GCC 'C' Compiler</dd>
+ <dt><a name="LLVMGXX"><tt>LLVMGXX</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the LLVM version of the GCC C++ Compiler</dd>
+ <dt><a name="LLVM_OBJ_ROOT"><tt>LLVM_OBJ_ROOT</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the top directory into which the output of the build is
+ placed.</dd>
+ <dt><a name="LLVM_SRC_ROOT"><tt>LLVM_SRC_ROOT</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the top directory in which the sources are found.</dd>
+ <dt><a name="LLVM_TARBALL_NAME"><tt>LLVM_TARBALL_NAME</tt></a><small>(configured)</small></dt>
+ <dd>Specifies the name of the distribution tarball to create. This is
+ configured from the name of the project and its version number.</dd>
+ <dt><a name="MKDIR"><tt>MKDIR</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>mkdir</tt> tool that creates
+ directories.</dd>
+ <dt><a name="PLATFORMSTRIPOPTS"><tt>PLATFORMSTRIPOPTS</tt></a></dt>
+ <dd>The options to provide to the linker to specify that a stripped (no
+ symbols) executable should be built.</dd>
+ <dt><a name="RANLIB"><tt>RANLIB</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>ranlib</tt> tool.</dd>
+ <dt><a name="RM"><tt>RM</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>rm</tt> tool.</dd>
+ <dt><a name="SED"><tt>SED</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>sed</tt> tool.</dd>
+ <dt><a name="SHLIBEXT"><tt>SHLIBEXT</tt></a><small>(configured)</small></dt>
+ <dd>Provides the filename extension to use for shared libraries.</dd>
+ <dt><a name="TBLGEN"><tt>TBLGEN</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>tblgen</tt> tool.</dd>
+ <dt><a name="TAR"><tt>TAR</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>tar</tt> tool.</dd>
+ <dt><a name="ZIP"><tt>ZIP</tt></a><small>(defaulted)</small></dt>
+ <dd>Specifies the path to the <tt>zip</tt> tool.</dd>
+ </dl>
</div>
<!-- ======================================================================= -->
@@ -454,46 +571,151 @@
<p>Variables listed in the table below can be used by the user's Makefile but
should not be changed. Changing the value will generally cause the build to go
wrong, so don't do it.</p>
- <table style="text-align:left">
- <tr><th>Variable Name</th><th>Variable Description</th></tr>
- <tr>
- <td><a href="#BUILD_SRC_DIR"><tt>BUILD_SRC_DIR</tt></a></td>
- <td>The project directory containing the directories source files.</td>
- </tr>
- <tr>
- <td><a href="#BUILD_OBJ_DIR"><tt>BUILD_OBJ_DIR</tt></a></td>
- <td>The project directory that will receive the object files.</td>
- </tr>
- <tr>
- <td><a href="#CONFIGURATION"><tt>CONFIGURATION</tt></a></td>
- <td>The name of the configuration being built.</td>
- </tr>
- <tr>
- <td><a href="#DESTDIR"><tt>DESTDIR</tt></a></td>
- <td>The top level directory into which files are installed.</td>
- </tr>
- <tr>
- <td><a href="#LLVM_SRC_ROOT"><tt>LLVM_SRC_ROOT</tt></a></td>
- <td>The top level directory of the LLVM source.</td>
- </tr>
- <tr>
- <td><a href="#LLVM_OBJ_ROOT"><tt>LLVM_OBJ_ROOT</tt></a></td>
- <td>The top level directory of the LLVM objects.</td>
- </tr>
- <tr>
- <td><a href="#OBJDIR"><tt>OBJDIR</tt></a></td>
- <td>The directory in which the project's object files should be placed.</td>
- </tr>
- <tr>
- <td><a href="#LIBDIR"><tt>LIBDIR</tt></a></td>
- <td>The directory in which the project's library files should be placed.</td>
- </tr>
- <tr>
- <td><a href="#TOOLDIR"><tt>TOOLDIR</tt></a></td>
- <td>The directory in which the project's executable tools should be
- placed.</td>
- </tr>
- </table>
+ <dl>
+ <dt><a name="bindir"><tt>bindir</tt></a></dt>
+ <dd>The directory into which executables will ultimately be installed. This
+ value is derived from the <tt>--prefix</tt> option given to
+ <tt>configure</tt>.</dd>
+ <dt><a name="bytecode_libdir"><tt>bytecode_libdir</tt></a></dt>
+ <dd>The directory into which bytecode libraries will ultimately be installed.
+ This value is derived from the <tt>--prefix</tt> option given to
+ <tt>configure</tt>.</dd>
+ <dt><a name="ConfigureScriptFLAGS"><tt>ConfigureScriptFLAGS</tt></a></dt>
+ <dd>Additional flags given to the <tt>configure</tt> script when
+ reconfiguring.</dd>
+ <dt><a name="DistDir"><tt>DistDir</tt></a></dt>
+ <dd>The <em>current</em> directory for which a distribution copy is being
+ made.</dd>
+ <dt><a name="Echo"><tt>Echo</tt></a></dt>
+ <dd>The LLVM Makefile System output command. This provides the
+ <tt>llvm[n]</tt> prefix and starts with @ so the command itself is not
+ printed by <tt>make</tt>.</dd>
+ <dt><a name="EchoCmd"><tt>EchoCmd</tt></a></dt>
+ <dd> Same as <a href="#Echo"><tt>Echo</tt></a> but without the leading @.
+ </dd>
+ <dt><a name="includedir"><tt>includedir</tt></a></dt>
+ <dd>The directory into which include files will ultimately be installed.
+ This value is derived from the <tt>--prefix</tt> option given to
+ <tt>configure</tt>.</dd>
+ <dt><a name="libdir"><tt>libdir</tt></a></dt><dd></dd>
+ <dd>The directory into which native libraries will ultimately be installed.
+ This value is derived from the <tt>--prefix</tt> option given to
+ <tt>configure</tt>.</dd>
+ <dt><a name="LibDir"><tt>LibDir</tt></a></dt>
+ <dd>The configuration specific directory into which libraries are placed
+ before installation.</dd>
+ <dt><a name="MakefileConfig"><tt>MakefileConfig</tt></a></dt>
+ <dd>Full path of the <tt>Makefile.config</tt> file.</dd>
+ <dt><a name="MakefileConfigIn"><tt>MakefileConfigIn</tt></a></dt>
+ <dd>Full path of the <tt>Makefile.config.in</tt> file.</dd>
+ <dt><a name="ObjDir"><tt>ObjDir</tt></a></dt>
+ <dd>The configuration and directory specific directory where build objects
+ (compilation results) are placed.</dd>
+ <dt><a name="SubDirs"><tt>SubDirs</tt></a></dt>
+ <dd>The complete list of sub-directories of the current directory as
+ specified by other variables.</dd>
+ <dt><a name="Sources"><tt>Sources</tt></a></dt>
+ <dd>The complete list of source files.</dd>
+ <dt><a name="sysconfdir"><tt>sysconfdir</tt></a></dt>
+ <dd>The directory into which configuration files will ulitmately be
+ installed. This value is derived from the <tt>--prefix</tt> option given to
+ <tt>configure</tt>.</dd>
+ <dt><a name="ToolDir"><tt>ToolDir</tt></a></dt>
+ <dd>The configuration specific directory into which executables are placed
+ before they are installed.</dd>
+ <dt><a name="TopDistDir"><tt>TopDistDir</tt></a></dt>
+ <dd>The top most directory into which the distribution files are copied.</dd>
+ <dt><a name="Verb"><tt>Verb</tt></a></dt>
+ <dd>Use this as the first thing on your build script lines to enable or
+ disable verbose mode. It expands to either an @ (quiet mode) or nothing
+ (verbose mode). </dd>
+ </dl>
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="intvars">Internal Variables</a></div>
+<div class="doc_text">
+ <p>Variables listed below are used by the LLVM Makefile System
+ and considered internal. You should not use these variables under any
+ circumstances.</p>
+ <dl>
+ <dt><a name="Archive"><tt>Archive</tt></a></dt><dd></dd>
+ <dt><a name="AR.Flags"><tt>AR.Flags</tt></a></dt><dd></dd>
+ <dt><a name="BaseNameSources"><tt>BaseNameSources</tt></a></dt><dd></dd>
+ <dt><a name="BCCompile.C"><tt>BCCompile.C</tt></a></dt><dd></dd>
+ <dt><a name="BCCompile.CXX"><tt>BCCompile.CXX</tt></a></dt><dd></dd>
+ <dt><a name="BCLinkLib"><tt>BCLinkLib</tt></a></dt><dd></dd>
+ <dt><a name="Burg"><tt>Burg</tt></a></dt><dd></dd>
+ <dt><a name="C.Flags"><tt>C.Flags</tt></a></dt><dd></dd>
+ <dt><a name="Compile.C"><tt>Compile.C</tt></a></dt><dd></dd>
+ <dt><a name="CompileCommonOpts"><tt>CompileCommonOpts</tt></a></dt><dd></dd>
+ <dt><a name="Compile.CXX"><tt>Compile.CXX</tt></a></dt><dd></dd>
+ <dt><a name="ConfigStatusScript"><tt>ConfigStatusScript</tt></a></dt><dd></dd>
+ <dt><a name="Configuration"><tt>Configuration</tt></a></dt><dd></dd>
+ <dt><a name="ConfigureScript"><tt>ConfigureScript</tt></a></dt><dd></dd>
+ <dt><a name="CPP.Flags"><tt>CPP.Flags</tt></a></dt><dd></dd>
+ <dt><a name="CPP.Flags "><tt>CPP.Flags </tt></a></dt><dd></dd>
+ <dt><a name="CXX.Flags"><tt>CXX.Flags</tt></a></dt><dd></dd>
+ <dt><a name="DependFiles"><tt>DependFiles</tt></a></dt><dd></dd>
+ <dt><a name="DestArchiveLib"><tt>DestArchiveLib</tt></a></dt><dd></dd>
+ <dt><a name="DestBytecodeLib"><tt>DestBytecodeLib</tt></a></dt><dd></dd>
+ <dt><a name="DestRelinkedLib"><tt>DestRelinkedLib</tt></a></dt><dd></dd>
+ <dt><a name="DestSharedLib"><tt>DestSharedLib</tt></a></dt><dd></dd>
+ <dt><a name="DestTool"><tt>DestTool</tt></a></dt><dd></dd>
+ <dt><a name="DistAlways"><tt>DistAlways</tt></a></dt><dd></dd>
+ <dt><a name="DistCheckDir"><tt>DistCheckDir</tt></a></dt><dd></dd>
+ <dt><a name="DistCheckTop"><tt>DistCheckTop</tt></a></dt><dd></dd>
+ <dt><a name="DistFiles"><tt>DistFiles</tt></a></dt><dd></dd>
+ <dt><a name="DistName"><tt>DistName</tt></a></dt><dd></dd>
+ <dt><a name="DistOther"><tt>DistOther</tt></a></dt><dd></dd>
+ <dt><a name="DistSources"><tt>DistSources</tt></a></dt><dd></dd>
+ <dt><a name="DistSubDirs"><tt>DistSubDirs</tt></a></dt><dd></dd>
+ <dt><a name="DistTarBZ2"><tt>DistTarBZ2</tt></a></dt><dd></dd>
+ <dt><a name="DistTarGZip"><tt>DistTarGZip</tt></a></dt><dd></dd>
+ <dt><a name="DistZip"><tt>DistZip</tt></a></dt><dd></dd>
+ <dt><a name="ExtraLibs"><tt>ExtraLibs</tt></a></dt><dd></dd>
+ <dt><a name="INCFiles"><tt>INCFiles</tt></a></dt><dd></dd>
+ <dt><a name="InternalTargets"><tt>InternalTargets</tt></a></dt><dd></dd>
+ <dt><a name="LD.Flags"><tt>LD.Flags</tt></a></dt><dd></dd>
+ <dt><a name="LexOutput"><tt>LexOutput</tt></a></dt><dd></dd>
+ <dt><a name="LibName.A"><tt>LibName.A</tt></a></dt><dd></dd>
+ <dt><a name="LibName.BC"><tt>LibName.BC</tt></a></dt><dd></dd>
+ <dt><a name="LibName.LA"><tt>LibName.LA</tt></a></dt><dd></dd>
+ <dt><a name="LibName.O"><tt>LibName.O</tt></a></dt><dd></dd>
+ <dt><a name="LibTool.Flags"><tt>LibTool.Flags</tt></a></dt><dd></dd>
+ <dt><a name="Link"><tt>Link</tt></a></dt><dd></dd>
+ <dt><a name="LLVMGCCLibDir"><tt>LLVMGCCLibDir</tt></a></dt><dd></dd>
+ <dt><a name="LLVMLibDir"><tt>LLVMLibDir</tt></a></dt><dd></dd>
+ <dt><a name="LLVMLibsOptions"><tt>LLVMLibsOptions</tt></a></dt><dd></dd>
+ <dt><a name="LLVMLibsPaths"><tt>LLVMLibsPaths</tt></a></dt><dd></dd>
+ <dt><a name="LLVMToolDir"><tt>LLVMToolDir</tt></a></dt><dd></dd>
+ <dt><a name="LLVMUsedLibs"><tt>LLVMUsedLibs</tt></a></dt><dd></dd>
+ <dt><a name="LocalTargets"><tt>LocalTargets</tt></a></dt><dd></dd>
+ <dt><a name="LTCompile.C"><tt>LTCompile.C</tt></a></dt><dd></dd>
+ <dt><a name="LTCompile.CXX"><tt>LTCompile.CXX</tt></a></dt><dd></dd>
+ <dt><a name="LTInstall"><tt>LTInstall</tt></a></dt><dd></dd>
+ <dt><a name="ObjectsBC"><tt>ObjectsBC</tt></a></dt><dd></dd>
+ <dt><a name="ObjectsLO"><tt>ObjectsLO</tt></a></dt><dd></dd>
+ <dt><a name="ObjectsO"><tt>ObjectsO</tt></a></dt><dd></dd>
+ <dt><a name="ObjMakefiles"><tt>ObjMakefiles</tt></a></dt><dd></dd>
+ <dt><a name="Parallel_Targets"><tt>Parallel_Targets</tt></a></dt><dd></dd>
+ <dt><a name="PreConditions"><tt>PreConditions</tt></a></dt><dd></dd>
+ <dt><a name="ProjLibsOptions"><tt>ProjLibsOptions</tt></a></dt><dd></dd>
+ <dt><a name="ProjLibsPaths"><tt>ProjLibsPaths</tt></a></dt><dd></dd>
+ <dt><a name="ProjUsedLibs"><tt>ProjUsedLibs</tt></a></dt><dd></dd>
+ <dt><a name="Ranlib"><tt>Ranlib</tt></a></dt><dd></dd>
+ <dt><a name="RecursiveTargets"><tt>RecursiveTargets</tt></a></dt><dd></dd>
+ <dt><a name="Relink"><tt>Relink</tt></a></dt><dd></dd>
+ <dt><a name="SrcMakefiles"><tt>SrcMakefiles</tt></a></dt><dd></dd>
+ <dt><a name="Strip"><tt>Strip</tt></a></dt><dd></dd>
+ <dt><a name="StripWarnMsg"><tt>StripWarnMsg</tt></a></dt><dd></dd>
+ <dt><a name="TableGen"><tt>TableGen</tt></a></dt><dd></dd>
+ <dt><a name="TDFiles"><tt>TDFiles</tt></a></dt><dd></dd>
+ <dt><a name="ToolBuildPath"><tt>ToolBuildPath</tt></a></dt><dd></dd>
+ <dt><a name="TopLevelTargets"><tt>TopLevelTargets</tt></a></dt><dd></dd>
+ <dt><a name="UserTargets"><tt>UserTargets</tt></a></dt><dd></dd>
+ <dt><a name="YaccOutput"><tt>YaccOutput</tt></a></dt><dd></dd>
+ </dl>
</div>
<!-- *********************************************************************** -->
@@ -506,7 +728,7 @@
<a href="mailto:rspencer at x10sys.com">Reid Spencer</a><br>
<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
- Last modified: $Date: 2004/10/25 19:37:46 $
+ Last modified: $Date: 2004/10/30 21:39:42 $
</address>
</body>
More information about the llvm-commits
mailing list