Rename the new unsigned and signed keywords to nuw and nsw,
[oota-llvm.git] / docs / MakefileGuide.html
index 6c0310da47fc096438da57e6cc8712970cccab3e..f996144e145372156f5e0d5b7acef8bfecc98864 100644 (file)
@@ -30,7 +30,7 @@
     <ol>
       <li><a href="#libraries">Libraries</a>
         <ol>
-         <li><a href="#BCModules">Bytecode Modules</a></li>
+         <li><a href="#BCModules">Bitcode Modules</a></li>
          <li><a href="#LoadableModules">Loadable Modules</a></li>
        </ol>
       </li>
   Normally, the makefile system will build all the software into a single
   <tt>libname.o</tt> (pre-linked) object. This means the library is not
   searchable and that the distinction between compilation units has been
-  dissolved. Optionally, you can ask for a shared library (.so), archive library
-  (.a) or to not have the default (relinked) library built. For example:</p>
+  dissolved. Optionally, you can ask for a shared library (.so) or archive
+  library (.a) built.  Archive libraries are the default. For example:</p>
   <pre><tt>
       LIBRARYNAME = mylib
       SHARED_LIBRARY = 1
       ARCHIVE_LIBRARY = 1
-      DONT_BUILD_RELINKED = 1
   </tt></pre>
   <p>says to build a library named "mylib" with both a shared library 
-  (<tt>mylib.so</tt>) and an archive library (<tt>mylib.a</tt>) version but
-  not to build the relinked object (<tt>mylib.o</tt>). The contents of all the
+  (<tt>mylib.so</tt>) and an archive library (<tt>mylib.a</tt>) version. The
+  contents of all the
   libraries produced will be the same, they are just constructed differently.
   Note that you normally do not need to specify the sources involved. The LLVM
   Makefile system will infer the source files from the contents of the source
 </div>
 
 <!-- ======================================================================= -->
-<div class="doc_subsubsection"><a name="BCModules">Bytecode Modules</a></div>
+<div class="doc_subsubsection"><a name="BCModules">Bitcode Modules</a></div>
 <div class="doc_text">
-  <p>In some situations, it is desireable to build a single bytecode module from
-  a variety of sources, instead of an archive, shared library, or bytecode 
-  library. Bytecode modules can be specified in addition to any of the other
+  <p>In some situations, it is desireable to build a single bitcode module from
+  a variety of sources, instead of an archive, shared library, or bitcode 
+  library. Bitcode modules can be specified in addition to any of the other
   types of libraries by defining the <a href="#MODULE_NAME">MODULE_NAME</a>
   variable. For example:</p>
   <pre><tt>
       MODULE_NAME = mymod
   </tt></pre>
   <p>will build a module named <tt>mymod.bc</tt> from the sources in the
-  directory. This module will be an aggregation of all the bytecode modules 
-  derived from the sources. The example will also build a bytecode archive 
-  containing a bytecode module for each compiled source file. The difference is
+  directory. This module will be an aggregation of all the bitcode modules 
+  derived from the sources. The example will also build a bitcode archive 
+  containing a bitcode module for each compiled source file. The difference is
   subtle, but important depending on how the module or library is to be linked.
   </p>
 </div>
     on.</li>
     <li>The <a href="#LINK_LIBS_IN_SHARED">LINK_LIBS_IN_SHARED</a> variable
     is turned on.</li>
-    <li>The <a href="#DONT_BUILD_RELINKED">DONT_BUILD_RELINKED</a> variable
-    is turned on.</li>
   </ol>
   <p>A loadable module is loaded by LLVM via the facilities of libtool's libltdl
   library which is part of <tt>lib/System</tt> implementation.</p>
     files. These sources will be built before any other target processing to 
     ensure they are present.</dd>
     <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>
+    <dd>If set to any value, causes a bitcode 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>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 equivalent 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
     setting this variable without also setting <tt>SHARED_LIBRARY</tt> will have
     no effect.</dd>
     <dt><a name="MODULE_NAME"><tt>MODULE_NAME</tt></a></dt>
-    <dd>Specifies the name of a bytecode module to be created. A bytecode 
+    <dd>Specifies the name of a bitcode module to be created. A bitcode 
     module can be specified in conjunction with other kinds of library builds 
-    or by itself. It constructs from the sources a single linked bytecode 
+    or by itself. It constructs from the sources a single linked bitcode 
     file.</dd>
     <dt><a name="NO_INSTALL"><tt>NO_INSTALL</tt></a></dt>
     <dd>Specifies that the build products of the directory should not be
   <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="PROJ_OBJ_DIR"><tt>PROJ_OBJ_DIR</tt></a></dt>
     <dd>The directory into which the products of build rules will be placed.
     This might be the same as 
     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="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>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="LLVMLD"><tt>LLVMLD</tt></a><small>(defaulted)</small></dt>
+    <dd>Specifies the path to the LLVM bitcode linker tool</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
     <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="ONLY_TOOLS"><tt>ONLY_TOOLS</tt></a></dt>
+    <dd>If set, specifies the list of tools to build.</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="BuildMode"><tt>BuildMode</tt></a></dt>
     <dd>The name of the type of build being performed: Debug, Release, or 
     Profile</dd>
-    <dt><a name="bytecode_libdir"><tt>bytecode_libdir</tt></a></dt>
-    <dd>The directory into which bytecode libraries will ultimately be 
+    <dt><a name="bitcode_libdir"><tt>bytecode_libdir</tt></a></dt>
+    <dd>The directory into which bitcode 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>
     CXX.Flags
     DependFiles
     DestArchiveLib
-    DestBytecodeLib
+    DestBitcodeLib
     DestModule
-    DestRelinkedLib
     DestSharedLib
     DestTool
     DistAlways
     INCFiles
     InternalTargets
     LD.Flags
-    LexFiles
-    LexOutput
     LibName.A
     LibName.BC
     LibName.LA
     LLVMToolDir
     LLVMUsedLibs
     LocalTargets
-    LTCompile.C
-    LTCompile.CXX
-    LTInstall
     Module
     ObjectsBC
     ObjectsLO
     ProjUsedLibs
     Ranlib
     RecursiveTargets
-    Relink
     SrcMakefiles
     Strip
     StripWarnMsg
     ToolBuildPath
     TopLevelTargets
     UserTargets
-    YaccFiles
-    YaccOutput
   </tt></p>
 </div>
 
 <hr>
 <address>
   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
-  src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
+  src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
   <a href="http://validator.w3.org/check/referer"><img
-  src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
+  src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 
   <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br>
   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>