<div class="doc_title">Documentation for the LLVM System</div>
<div class="doc_text">
+<table class="layout" width="95%"><tr class="layout"><td class="left">
<ul>
<li><a href="#llvmdesign">LLVM Design</a></li>
<li><a href="#userguide">LLVM User Guides</a></li>
<li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
<li><a href="#maillist">LLVM Mailing Lists</a></li>
</ul>
+</td><td class="right">
+ <form action="http://www.google.com/search" method=get>
+ <input type="hidden" name="sitesearch" value="llvm.cs.uiuc.edu/docs">
+ <input type=text name=q size=25><br>
+ <input type=submit value="Search the LLVM Docs" name="submit">
+ </form>
+</td></tr></table>
</div>
<div class="doc_author">
<!--=======================================================================-->
<ul>
-<li><a href="pubs/2004-01-30-CGO-LLVM.html"> LLVM: A Compilation Framework for
-Lifelong Program Analysis & Transformation</a>: - Describes
-the LLVM instruction set and compilation strategy. This should be the first
-document you read to get an overview of LLVM.</li>
+<li><a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
+Compilation Framework for Lifelong Program Analysis & Transformation</a>: -
+Describes the LLVM instruction set and compilation strategy. This should be the
+first document you read to get an overview of LLVM.</li>
<li><a href="LangRef.html">LLVM Reference Manual</a> - Defines the LLVM
intermediate representation, the assembly form of the different nodes, and
Everything from unpacking and compilation of the distribution to execution of
some tools.</li>
+<li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
+Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
+those using Visual Studio on Windows.</li>
+
<li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
-manual for the LLVM command line utilities ("man" pages for LLVM tools).</li>
+manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
+Current tools:
+ <a href="CommandGuide/html/llvm-ar.html">llvm-ar</a>,
+ <a href="CommandGuide/html/llvm-ranlib.html">llvm-ranlib</a>,
+ <a href="CommandGuide/html/llvm-as.html">llvm-as</a>,
+ <a href="CommandGuide/html/llvm-dis.html">llvm-dis</a>,
+ <a href="CommandGuide/html/opt.html">opt</a>,
+ <a href="CommandGuide/html/llc.html">llc</a>,
+ <a href="CommandGuide/html/lli.html">lli</a>,
+ <a href="CommandGuide/html/llvm-link.html">llvm-link</a>,
+ <a href="CommandGuide/html/analyze.html">analyze</a>,
+ <a href="CommandGuide/html/llvm-nm.html">llvm-nm</a>,
+ <a href="CommandGuide/html/llvm-prof.html">llvm-prof</a>,
+ <a href="CommandGuide/html/llvmgcc.html">llvmgcc</a>,
+ <a href="CommandGuide/html/llvmgxx.html">llvmgxx</a>,
+ <a href="CommandGuide/html/gccas.html">gccas</a>,
+ <a href="CommandGuide/html/gccld.html">gccld</a>,
+ <a href="CommandGuide/html/stkrc.html">stkrc</a>,
+ <a href="CommandGuide/html/bugpoint.html">bugpoint</a>,
+ <a href="CommandGuide/html/extract.html">extract</a>,
+ <a href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
+ <a href="CommandGuide/html/llvmc.html">llvmc</a>
+</li>
<li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
questions and problems and their solutions.</li>
<li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
Instructions for building the front-end from source.</li>
+<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
+and concepts used in LLVM.</li>
+
<li><a name="irc">You can probably find help on the unofficial LLVM IRC
channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
using the mozilla browser, and have chatzilla installed, you can <a
code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
header files and libraries.</li>
+<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
+LLVM makefiles work and how to use them.</li>
+
<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
Provides information on using the command line parsing library.</li>
-<li><a href="CodingStandards.html">Recommended LLVM Coding standards</a> -
+<li><a href="CodingStandards.html">LLVM Coding standards</a> -
Details the LLVM coding standards and provides useful information on writing
efficient C++ code.</li>
-<li><a href="OpenProjects.html">Open Projects</a> - Look here if you are
-interested in doing something with LLVM but aren't sure what needs to be
-done.</li>
-
<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
to add instructions and intrinsics to LLVM.</li>
-<li><a href="CodingStandards.html">Coding Standards</a> - Guidelines for
-hacking LLVM source.</li>
-
-<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
-and concepts used in LLVM.</li>
+<li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
+understand how to use the libraries produced when LLVM is compiled.</li>
<li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
-documentation</a> (<a href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">
-classes</a>)</li>
+documentation</a> (<a
+href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">classes</a>)</li>
<li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
Browser</a></li>
<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
on how to write LLVM transformations and analyses.</li>
+<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
+on how to write LLVM backends for machine targets.</li>
+
<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
Generator</a> - The design and implementation of the LLVM code generator.
Useful if you are working on retargetting LLVM to a new architecture, designing
on how to write a new alias analysis implementation or how to use existing
analyses.</li>
-<li><a href="Stacker.html">The Stacker Cronicles</a> - This document
+<li><a href="Stacker.html">The Stacker Chronicles</a> - This document
describes both the Stacker language and LLVM frontend, but also some details
about LLVM useful for those writing front-ends.</li>
LLVM</a> - This document describes the design and philosophy behind the LLVM
source-level debugger.</li>
-<li><a href="Bugpoint.html">Bugpoint</a> automatic bug finder and
-test-case reducer description and usage information.</li>
+<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
+reducer description and usage information.</li>
<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
describes the design and configuration of the LLVM compiler driver tool,
<tt>llvmc</tt>.</li>
+<li><a href="SystemLibrary.html">System Library</a> - This document describes
+the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
+portable</li>
+
</ul>
<!--=======================================================================-->
projects / oota-llvm.git / blobdiff