projects / oota-llvm.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
minor tidying of comments.
[oota-llvm.git] / docs / UsingLibraries.html
diff --git a/docs/UsingLibraries.html b/docs/UsingLibraries.html
index ac148f786345e1679c119554fda89f466f62fb9e..af57907ef66a730bbc6977265999d2afb5a862fe 100644 (file)
--- a/docs/UsingLibraries.html
+++ b/docs/UsingLibraries.html
@@ -81,15 +81,15 @@
   <tr><td>LLVMAsmParser</td><td><tt>.a</tt></td>
     <td>LLVM assembly parsing</td></tr>
   <tr><td>LLVMBCReader</td><td><tt>.a</tt></td>
   <tr><td>LLVMAsmParser</td><td><tt>.a</tt></td>
     <td>LLVM assembly parsing</td></tr>
   <tr><td>LLVMBCReader</td><td><tt>.a</tt></td>
-    <td>LLVM bytecode reading</td></tr>
+    <td>LLVM bitcode reading</td></tr>
   <tr><td>LLVMBCWriter</td><td><tt>.a</tt></td>
   <tr><td>LLVMBCWriter</td><td><tt>.a</tt></td>
-    <td>LLVM bytecode writing</td></tr>
+    <td>LLVM bitcode writing</td></tr>
   <tr><td>LLVMCore</td><td><tt>.a</tt></td>
     <td>LLVM core intermediate representation</td></tr>
   <tr><td>LLVMDebugger</td><td><tt>.a</tt></td>
     <td>Source level debugging support</td></tr>
   <tr><td>LLVMLinker</td><td><tt>.a</tt></td>
   <tr><td>LLVMCore</td><td><tt>.a</tt></td>
     <td>LLVM core intermediate representation</td></tr>
   <tr><td>LLVMDebugger</td><td><tt>.a</tt></td>
     <td>Source level debugging support</td></tr>
   <tr><td>LLVMLinker</td><td><tt>.a</tt></td>
-    <td>Bytecode and archive linking interface</td></tr>
+    <td>Bitcode and archive linking interface</td></tr>
   <tr><td>LLVMSupport</td><td><tt>.a</tt></td>
     <td>General support utilities</td></tr>
   <tr><td>LLVMSystem</td><td><tt>.a</tt></td>
   <tr><td>LLVMSupport</td><td><tt>.a</tt></td>
     <td>General support utilities</td></tr>
   <tr><td>LLVMSystem</td><td><tt>.a</tt></td>
@@ -112,10 +112,8 @@
     <td>All inter-procedural optimization passes.</td></tr>
   <tr><td>LLVMScalarOpts</td><td><tt>.a</tt></td>
     <td>All scalar optimization passes.</td></tr>
     <td>All inter-procedural optimization passes.</td></tr>
   <tr><td>LLVMScalarOpts</td><td><tt>.a</tt></td>
     <td>All scalar optimization passes.</td></tr>
-  <tr><td>LLVMTransforms</td><td><tt>.a</tt></td>
-    <td>Uncategorized transformation passes.</td></tr>
   <tr><td>LLVMTransformUtils</td><td><tt>.a</tt></td>
   <tr><td>LLVMTransformUtils</td><td><tt>.a</tt></td>
-    <td>Transformation utilities.</td></tr>
+    <td>Transformation utilities used by many passes.</td></tr>
 
   <tr><th colspan="3">Code Generation Libraries </th></tr>
   <tr><td>LLVMCodeGen</td><td><tt>.o</tt></td>
 
   <tr><th colspan="3">Code Generation Libraries </th></tr>
   <tr><td>LLVMCodeGen</td><td><tt>.o</tt></td>
@@ -143,9 +141,9 @@
 
   <tr><th colspan="3">Runtime Libraries</th></tr>
   <tr><td>LLVMInterpreter</td><td><tt>.o</tt></td>
 
   <tr><th colspan="3">Runtime Libraries</th></tr>
   <tr><td>LLVMInterpreter</td><td><tt>.o</tt></td>
-    <td>Bytecode Interpreter</td></tr>
+    <td>Bitcode Interpreter</td></tr>
   <tr><td>LLVMJIT</td><td><tt>.o</tt></td>
   <tr><td>LLVMJIT</td><td><tt>.o</tt></td>
-    <td>Bytecode JIT Compiler</td></tr>
+    <td>Bitcode JIT Compiler</td></tr>
   <tr><td>LLVMExecutionEngine</td><td><tt>.o</tt></td>
     <td>Virtual machine engine</td></tr>
 </table>
   <tr><td>LLVMExecutionEngine</td><td><tt>.o</tt></td>
     <td>Virtual machine engine</td></tr>
 </table>
@@ -154,7 +152,7 @@
 <!-- ======================================================================= -->
 <div class="doc_section"><a name="dependencies"></a>Using llvm-config</div>
 <div class="doc_text">
 <!-- ======================================================================= -->
 <div class="doc_section"><a name="dependencies"></a>Using llvm-config</div>
 <div class="doc_text">
-  <p>The <p>llvm-config</p> tool is a perl script that produces on its output
+  <p>The <tt>llvm-config</tt> tool is a perl script that produces on its output
   various kinds of information. For example, the source or object directories 
   used to build LLVM can be accessed by passing options to <tt>llvm-config</tt>.
   For complete details on this tool, please see the
   various kinds of information. For example, the source or object directories 
   used to build LLVM can be accessed by passing options to <tt>llvm-config</tt>.
   For complete details on this tool, please see the
@@ -167,15 +165,15 @@
     <li><tt>--ldflags</tt>. This generates the command line options necessary to
     be passed to the <tt>ld</tt> tool in order to link with LLVM. Most notably,
     the <tt>-L</tt> option is provided to specify a library search directory 
     <li><tt>--ldflags</tt>. This generates the command line options necessary to
     be passed to the <tt>ld</tt> tool in order to link with LLVM. Most notably,
     the <tt>-L</tt> option is provided to specify a library search directory 
-    that contains the LLVM libraries.
+    that contains the LLVM libraries.</li>
     <li><tt>--libs</tt>. This generates command line options suitable for
     use with a gcc-style linker. That is, libraries are given with a -l option
     and object files are given with a full path.</li>
     <li><tt>--libnames</tt>. This generates a list of just the library file
     names. If you know the directory in which these files reside (see --ldflags)
     then you can find the libraries there.</li>
     <li><tt>--libs</tt>. This generates command line options suitable for
     use with a gcc-style linker. That is, libraries are given with a -l option
     and object files are given with a full path.</li>
     <li><tt>--libnames</tt>. This generates a list of just the library file
     names. If you know the directory in which these files reside (see --ldflags)
     then you can find the libraries there.</li>
-    <li><tt>--libfiles</tt></li>. This generates the full path names of the
-    LLVM library files.
+    <li><tt>--libfiles</tt>. This generates the full path names of the
+    LLVM library files.</li>
   </ol>
   <p>If you wish to delve further into how <tt>llvm-config</tt> generates the
   correct order (based on library dependencies), please see the tool named
   </ol>
   <p>If you wish to delve further into how <tt>llvm-config</tt> generates the
   correct order (based on library dependencies), please see the tool named
@@ -215,7 +213,6 @@
   </ul></dd>
   <dt><b>libLLVMAsmParser.a</b</dt><dd><ul>
     <li>libLLVMCore.a</li>
   </ul></dd>
   <dt><b>libLLVMAsmParser.a</b</dt><dd><ul>
     <li>libLLVMCore.a</li>
-    <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
   <dt><b>libLLVMBCReader.a</b</dt><dd><ul>
     <li>libLLVMSystem.a</li>
   </ul></dd>
   <dt><b>libLLVMBCReader.a</b</dt><dd><ul>
@@ -231,9 +228,11 @@
   <dt><b>libLLVMCodeGen.a</b</dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
     <li>libLLVMCore.a</li>
   <dt><b>libLLVMCodeGen.a</b</dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
     <li>libLLVMCore.a</li>
+    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
+    <li>libLLVMTransformUtils.a</li>
   </ul></dd>
   <dt><b>libLLVMCore.a</b</dt><dd><ul>
     <li>libLLVMSupport.a</li>
   </ul></dd>
   <dt><b>libLLVMCore.a</b</dt><dd><ul>
     <li>libLLVMSupport.a</li>
@@ -255,6 +254,7 @@
     <li>libLLVMArchive.a</li>
     <li>libLLVMBCReader.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMArchive.a</li>
     <li>libLLVMBCReader.a</li>
     <li>libLLVMCore.a</li>
+    <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
   <dt><b>libLLVMScalarOpts.a</b</dt><dd><ul>
     <li>libLLVMSystem.a</li>
   </ul></dd>
   <dt><b>libLLVMScalarOpts.a</b</dt><dd><ul>
@@ -266,6 +266,7 @@
     <li>libLLVMTransformUtils.a</li>
   </ul></dd>
   <dt><b>libLLVMSelectionDAG.a</b</dt><dd><ul>
     <li>libLLVMTransformUtils.a</li>
   </ul></dd>
   <dt><b>libLLVMSelectionDAG.a</b</dt><dd><ul>
+    <li>libLLVMAnalysis.a</li>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
@@ -280,25 +281,17 @@
   <dt><b>libLLVMSystem.a</b</dt><dd><ul>
   </ul></dd>
   <dt><b>libLLVMTarget.a</b</dt><dd><ul>
   <dt><b>libLLVMSystem.a</b</dt><dd><ul>
   </ul></dd>
   <dt><b>libLLVMTarget.a</b</dt><dd><ul>
-    <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
   <dt><b>libLLVMTransformUtils.a</b</dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
   </ul></dd>
   <dt><b>libLLVMTransformUtils.a</b</dt><dd><ul>
     <li>libLLVMAnalysis.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
-    <li>libLLVMipa.a</li>
-  </ul></dd>
-  <dt><b>libLLVMTransforms.a</b</dt><dd><ul>
-    <li>libLLVMCore.a</li>
-    <li>libLLVMSupport.a</li>
     <li>libLLVMTarget.a</li>
     <li>libLLVMTarget.a</li>
-    <li>libLLVMTransformUtils.a</li>
+    <li>libLLVMipa.a</li>
   </ul></dd>
   <dt><b>libLLVMbzip2.a</b</dt><dd><ul>
   </ul></dd>
   </ul></dd>
   <dt><b>libLLVMbzip2.a</b</dt><dd><ul>
   </ul></dd>
@@ -317,10 +310,22 @@
     <li>libLLVMTransformUtils.a</li>
     <li>libLLVMipa.a</li>
   </ul></dd>
     <li>libLLVMTransformUtils.a</li>
     <li>libLLVMipa.a</li>
   </ul></dd>
+  <dt><b>libLLVMlto.a</b</dt><dd><ul>
+    <li>libLLVMAnalysis.a</li>
+    <li>libLLVMBCReader.a</li>
+    <li>libLLVMBCWriter.a</li>
+    <li>libLLVMCore.a</li>
+    <li>libLLVMLinker.a</li>
+    <li>libLLVMScalarOpts.a</li>
+    <li>libLLVMSupport.a</li>
+    <li>libLLVMSystem.a</li>
+    <li>libLLVMTarget.a</li>
+    <li>libLLVMipa.a</li>
+    <li>libLLVMipo.a</li>
+  </ul></dd>
   <dt><b>LLVMARM.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
   <dt><b>LLVMARM.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
@@ -329,7 +334,6 @@
   <dt><b>LLVMAlpha.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
   <dt><b>LLVMAlpha.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
@@ -343,15 +347,9 @@
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMTarget.a</li>
+    <li>libLLVMTransformUtils.a</li>
     <li>libLLVMipa.a</li>
   </ul></dd>
     <li>libLLVMipa.a</li>
   </ul></dd>
-  <dt><b>LLVMDataStructure.o</b</dt><dd><ul>
-    <li>libLLVMAnalysis.a</li>
-    <li>libLLVMCore.a</li>
-    <li>libLLVMSupport.a</li>
-    <li>libLLVMSystem.a</li>
-    <li>libLLVMTarget.a</li>
-  </ul></dd>
   <dt><b>LLVMExecutionEngine.o</b</dt><dd><ul>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
   <dt><b>LLVMExecutionEngine.o</b</dt><dd><ul>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
@@ -361,7 +359,6 @@
   <dt><b>LLVMIA64.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
   <dt><b>LLVMIA64.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
@@ -369,6 +366,7 @@
   </ul></dd>
   <dt><b>LLVMInterpreter.o</b</dt><dd><ul>
     <li>LLVMExecutionEngine.o</li>
   </ul></dd>
   <dt><b>LLVMInterpreter.o</b</dt><dd><ul>
     <li>LLVMExecutionEngine.o</li>
+    <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
@@ -376,7 +374,6 @@
   </ul></dd>
   <dt><b>LLVMJIT.o</b</dt><dd><ul>
     <li>LLVMExecutionEngine.o</li>
   </ul></dd>
   <dt><b>LLVMJIT.o</b</dt><dd><ul>
     <li>LLVMExecutionEngine.o</li>
-    <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMCore.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
@@ -385,7 +382,6 @@
   <dt><b>LLVMPowerPC.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
   <dt><b>LLVMPowerPC.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
@@ -394,7 +390,6 @@
   <dt><b>LLVMSparc.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
   <dt><b>LLVMSparc.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
@@ -403,7 +398,6 @@
   <dt><b>LLVMX86.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
   <dt><b>LLVMX86.o</b</dt><dd><ul>
     <li>libLLVMCodeGen.a</li>
     <li>libLLVMCore.a</li>
-    <li>libLLVMScalarOpts.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
     <li>libLLVMSelectionDAG.a</li>
     <li>libLLVMSupport.a</li>
     <li>libLLVMSystem.a</li>
C/C++ LLVM-based compilers that forbids OOTA behaviors