1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
5 <title>Documentation for the LLVM System</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
10 <div class="doc_title">Documentation for the LLVM System</div>
12 <div class="doc_text">
14 <li><a href="#llvmdesign">LLVM Design</a></li>
15 <li><a href="#userguide">LLVM User Guides</a></li>
16 <li><a href="#llvmprog">General LLVM Programming Documentation</a></li>
17 <li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
18 <li><a href="#maillist">LLVM Mailing Lists</a></li>
22 <div class="doc_author">
23 <p>Written by <a href="http://llvm.cs.uiuc.edu">The LLVM Team</a></p>
26 <!--=======================================================================-->
27 <div class="doc_section"><a name="llvmdesign">LLVM Design</a></div>
28 <!--=======================================================================-->
31 <li><a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
32 Compilation Framework for Lifelong Program Analysis & Transformation</a>: -
33 Describes the LLVM instruction set and compilation strategy. This should be the
34 first document you read to get an overview of LLVM.</li>
36 <li><a href="LangRef.html">LLVM Reference Manual</a> - Defines the LLVM
37 intermediate representation, the assembly form of the different nodes, and
38 provides reference information about the different tools in LLVM.</li>
40 <li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
44 <!--=======================================================================-->
45 <div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
46 <!--=======================================================================-->
49 <li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
50 Discusses how to get up and running quickly with the LLVM infrastructure.
51 Everything from unpacking and compilation of the distribution to execution of
54 <li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
55 manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
57 <a href="CommandGuide/html/llvm-ar.html">llvm-ar</a>,
58 <a href="CommandGuide/html/llvm-as.html">llvm-as</a>,
59 <a href="CommandGuide/html/llvm-dis.html">llvm-dis</a>,
60 <a href="CommandGuide/html/opt.html">opt</a>,
61 <a href="CommandGuide/html/llc.html">llc</a>,
62 <a href="CommandGuide/html/lli.html">lli</a>,
63 <a href="CommandGuide/html/llvm-link.html">llvm-link</a>,
64 <a href="CommandGuide/html/analyze.html">analyze</a>,
65 <a href="CommandGuide/html/llvm-nm.html">llvm-nm</a>,
66 <a href="CommandGuide/html/llvm-prof.html">llvm-prof</a>,
67 <a href="CommandGuide/html/llvmgcc.html">llvmgcc</a>,
68 <a href="CommandGuide/html/llvmgxx.html">llvmgxx</a>,
69 <a href="CommandGuide/html/gccas.html">gccas</a>,
70 <a href="CommandGuide/html/gccld.html">gccld</a>,
71 <a href="CommandGuide/html/stkrc.html">stkrc</a>,
72 <a href="CommandGuide/html/bugpoint.html">bugpoint</a>,
73 <a href="CommandGuide/html/extract.html">extract</a>,
74 <a href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
75 <a href="CommandGuide/html/llvmc.html">llvmc</a>
78 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
79 questions and problems and their solutions.</li>
81 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
82 - This describes new features, known bugs, and other limitations.</li>
84 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
85 Instructions for properly submitting information about any bugs you run into in
88 <li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
89 manual for using the LLVM test suite.</li>
91 <li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
92 Instructions for building the front-end from source.</li>
94 <li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
95 and concepts used in LLVM.</li>
97 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
98 channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
99 using the mozilla browser, and have chatzilla installed, you can <a
100 href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
105 <!--=======================================================================-->
106 <div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
107 <!--=======================================================================-->
110 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
111 Introduction to the general layout of the LLVM sourcebase, important classes
112 and APIs, and some tips & tricks.</li>
114 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
115 templates for new projects that <em>use</em> the LLVM infrastructure. The
116 templates (directory organization, Makefiles, and test tree) allow the project
117 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
118 header files and libraries.</li>
120 <li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
121 LLVM makefiles work and how to use them.</li>
123 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
124 Provides information on using the command line parsing library.</li>
126 <li><a href="CodingStandards.html">LLVM Coding standards</a> -
127 Details the LLVM coding standards and provides useful information on writing
128 efficient C++ code.</li>
130 <li><a href="OpenProjects.html">Open Projects</a> - Look here if you are
131 interested in doing something with LLVM but aren't sure what needs to be
134 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
135 to add instructions and intrinsics to LLVM.</li>
137 <li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
138 understand how to use the libraries produced when LLVM is compiled.</li>
140 <li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
141 documentation</a> (<a href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">
144 <li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
149 <!--=======================================================================-->
150 <div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
151 <!--=======================================================================-->
155 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
156 on how to write LLVM transformations and analyses.</li>
158 <li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
159 on how to write LLVM backends for machine targets.</li>
161 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
162 Generator</a> - The design and implementation of the LLVM code generator.
163 Useful if you are working on retargetting LLVM to a new architecture, designing
164 a new codegen pass, or enhancing existing components.</li>
166 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
167 Describes the TableGen tool, which is used heavily by the LLVM code
170 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
171 on how to write a new alias analysis implementation or how to use existing
174 <li><a href="Stacker.html">The Stacker Chronicles</a> - This document
175 describes both the Stacker language and LLVM frontend, but also some details
176 about LLVM useful for those writing front-ends.</li>
178 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
179 LLVM</a> - The interfaces source-language compilers should use for compiling
182 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
183 LLVM</a> - This document describes the design and philosophy behind the LLVM
184 source-level debugger.</li>
186 <li><a href="CommandGuide/html/bugpoint.html">bugpoint</a> - automatic bug
187 finder and test-case reducer description and usage information.</li>
189 <li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
190 describes the design and configuration of the LLVM compiler driver tool,
195 <!--=======================================================================-->
196 <div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
197 <!--=======================================================================-->
200 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
201 LLVM Announcements List</a>: This is a low volume list that provides important
202 announcements regarding LLVM. It gets email about once a month.</li>
204 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
205 List</a>: This list is for people who want to be included in technical
206 discussions of LLVM. People post to this list when they have questions about
207 writing code for or using the LLVM tools. It is relatively low volume.</li>
209 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &
210 Patches Archive</a>: This list gets emailed every time a bug is opened and
211 closed, and when people submit patches to be included in LLVM. It is higher
212 volume than the LLVMdev list.</li>
214 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
215 Archive</a>: This list contains all commit messages that are made when LLVM
216 developers commit code changes to the CVS archive. It is useful for those who
217 want to stay on the bleeding edge of LLVM development. This list is very high
222 <!-- *********************************************************************** -->
226 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
227 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
228 <a href="http://validator.w3.org/check/referer"><img
229 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
231 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
232 Last modified: $Date$