1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <title>Documentation for the LLVM System at SVN head</title>
7 <link rel="stylesheet" href="llvm.css" type="text/css">
11 <h1>Documentation for the LLVM System at SVN head</h1>
13 <p class="doc_warning">If you are using a released version of LLVM,
14 see <a href="http://llvm.org/releases/">the download page</a> to find
15 your documentation.</p>
17 <table class="layout" width="95%"><tr class="layout"><td class="left">
19 <li><a href="#llvmdesign">LLVM Design</a></li>
20 <li><a href="/pubs/">LLVM Publications</a></li>
21 <li><a href="#userguide">LLVM User Guides</a></li>
22 <li><a href="#llvmprog">LLVM Programming Documentation</a></li>
23 <li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
24 <li><a href="#develprocess">LLVM Development Process Documentation</a></li>
25 <li><a href="#maillist">LLVM Mailing Lists</a></li>
27 </td><td class="right">
28 <form action="http://www.google.com/search" method=get>
30 <input type="hidden" name="sitesearch" value="llvm.org/docs">
31 <input type=text name=q size=25><br>
32 <input type=submit value="Search the LLVM Docs" name="submit">
37 <div class="doc_author">
38 <p>Written by <a href="http://llvm.org/">The LLVM Team</a></p>
41 <!--=======================================================================-->
42 <h2><a name="llvmdesign">LLVM Design & Overview</a></h2>
43 <!--=======================================================================-->
46 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
47 intermediate representation.</li>
48 <li><a href="http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html">Introduction to the LLVM Compiler </a> - Presentation providing a users introduction to LLVM.</li>
49 <li><a href="http://www.aosabook.org/en/llvm.html">Intro to LLVM</a> - book chapter providing a compiler hacker's introduction to LLVM.</li>
50 <li><a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
51 Lifelong Program Analysis & Transformation</a> - Design overview.</li>
52 <li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
53 Multi-Stage Optimization</a> - More details (quite old now).</li>
54 <li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
55 frequent questions about LLVM's most frequently misunderstood instruction.</li>
58 <!--=======================================================================-->
59 <h2><a name="userguide">LLVM User Guides</a></h2>
60 <!--=======================================================================-->
63 <li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
64 Discusses how to get up and running quickly with the LLVM infrastructure.
65 Everything from unpacking and compilation of the distribution to execution of
68 <li><a href="CMake.html">LLVM CMake guide</a> - An addendum to the main Getting
69 Started guide for those using the <a href="http://www.cmake.org/">CMake build
73 <li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
74 Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
75 those using Visual Studio on Windows.</li>
77 <li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
78 LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
79 <li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
80 policy towards developers and their contributions.</li>
82 <li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
83 manual for the LLVM command line utilities ("man" pages for LLVM tools).</li>
85 <li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of
86 optimizations and analyses implemented in LLVM.</li>
88 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
89 questions and problems and their solutions.</li>
91 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
92 - This describes new features, known bugs, and other limitations.</li>
94 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
95 Instructions for properly submitting information about any bugs you run into in
98 <li><a href="TestingGuide.html">LLVM Testing Infrastructure Guide</a> - A reference
99 manual for using the LLVM testing infrastructure.</li>
101 <li><a href="GCCFEBuildInstrs.html">How to build the Ada/C/C++/Fortran front-ends</a> -
102 Instructions for building gcc front-ends from source.</li>
104 <li><a href="Packaging.html">Packaging guide</a> - Advice on packaging
105 LLVM into a distribution.</li>
107 <li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
108 and concepts used in LLVM.</li>
110 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
111 channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
112 using the mozilla browser, and have chatzilla installed, you can <a
113 href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
115 <li><a href="HowToAddABuilder.html">How To Add Your Build Configuration
116 To LLVM Buildbot Infrastructure</a> - Instructions for adding new builder to
117 LLVM buildbot master.</li>
122 <!--=======================================================================-->
123 <h2><a name="llvmprog">LLVM Programming Documentation</a></h2>
124 <!--=======================================================================-->
127 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
128 intermediate representation and the assembly form of the different nodes.</li>
130 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
131 Introduction to the general layout of the LLVM sourcebase, important classes
132 and APIs, and some tips & tricks.</li>
134 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
135 Provides information on using the command line parsing library.</li>
137 <li><a href="CodingStandards.html">LLVM Coding standards</a> -
138 Details the LLVM coding standards and provides useful information on writing
139 efficient C++ code.</li>
141 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
142 to add instructions and intrinsics to LLVM.</li>
144 <li><a href="http://llvm.org/doxygen/">Doxygen generated
145 documentation</a> (<a
146 href="http://llvm.org/doxygen/inherits.html">classes</a>)
148 (<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
151 <li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
155 <!--=======================================================================-->
156 <h2><a name="subsystems">LLVM Subsystem Documentation</a></h2>
157 <!--=======================================================================-->
161 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
162 on how to write LLVM transformations and analyses.</li>
164 <li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
165 on how to write LLVM backends for machine targets.</li>
167 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
168 Generator</a> - The design and implementation of the LLVM code generator.
169 Useful if you are working on retargetting LLVM to a new architecture, designing
170 a new codegen pass, or enhancing existing components.</li>
172 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
173 Describes the TableGen tool, which is used heavily by the LLVM code
176 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
177 on how to write a new alias analysis implementation or how to use existing
180 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
181 LLVM</a> - The interfaces source-language compilers should use for compiling
184 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
185 LLVM</a> - This document describes the design and philosophy behind the LLVM
186 source-level debugger.</li>
188 <li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
189 - This document describes the design and implementation of exception handling
192 <li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
193 reducer description and usage information.</li>
195 <li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a> - This describes
196 the file format and encoding used for LLVM "bc" files.</li>
198 <li><a href="SystemLibrary.html">System Library</a> - This document describes
199 the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
202 <li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
203 document describes the interface between LLVM intermodular optimizer and
204 the linker and its design</li>
206 <li><a href="GoldPlugin.html">The LLVM gold plugin</a> - How to build your
207 programs with link-time optimization on Linux.</li>
209 <li><a href="DebuggingJITedCode.html">The GDB JIT interface</a> - How to debug
210 JITed code with GDB.</li>
212 <li><a href="BranchWeightMetadata.html">Branch Weight Metadata</a> - Provides
213 information about Branch Prediction Information.</li>
217 <!--=======================================================================-->
218 <h2><a name="develprocess">LLVM Development Process Documentation</a></h2>
219 <!--=======================================================================-->
223 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
224 templates for new projects that <em>use</em> the LLVM infrastructure. The
225 templates (directory organization, Makefiles, and test tree) allow the project
226 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
227 header files and libraries.</li>
229 <li><a href="LLVMBuild.html">LLVMBuild Documentation</a> - Describes the
230 LLVMBuild organization and files used by LLVM to specify component
233 <li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
234 LLVM makefiles work and how to use them.</li>
236 <li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
237 is a guide to preparing LLVM releases. Most developers can ignore it.</li>
241 <!--=======================================================================-->
242 <h2><a name="maillist">LLVM Mailing Lists</a></h2>
243 <!--=======================================================================-->
246 <li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce">
247 LLVM Announcements List</a>: This is a low volume list that provides important
248 announcements regarding LLVM. It gets email about once a month.</li>
250 <li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
251 List</a>: This list is for people who want to be included in technical
252 discussions of LLVM. People post to this list when they have questions about
253 writing code for or using the LLVM tools. It is relatively low volume.</li>
255 <li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &
256 Patches Archive</a>: This list gets emailed every time a bug is opened and
257 closed, and when people submit patches to be included in LLVM. It is higher
258 volume than the LLVMdev list.</li>
260 <li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/">Commits
261 Archive</a>: This list contains all commit messages that are made when LLVM
262 developers commit code changes to the repository. It is useful for those who
263 want to stay on the bleeding edge of LLVM development. This list is very high
266 <li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
267 Test Results Archive</a>: A message is automatically sent to this list by every
268 active nightly tester when it completes. As such, this list gets email several
269 times each day, making it a high volume list.</li>
273 <!-- *********************************************************************** -->
277 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
278 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
279 <a href="http://validator.w3.org/check/referer"><img
280 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
282 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
283 Last modified: $Date$