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 at SVN head</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
10 <h1>Documentation for the LLVM System at SVN head</h1>
12 <p class="doc_warning">If you are using a released version of LLVM,
13 see <a href="http://llvm.org/releases/">the download page</a> to find
14 your documentation.</p>
16 <table class="layout" width="95%"><tr class="layout"><td class="left">
18 <li><a href="#llvmdesign">LLVM Design</a></li>
19 <li><a href="/pubs/">LLVM Publications</a></li>
20 <li><a href="#userguide">LLVM User Guides</a></li>
21 <li><a href="#llvmprog">General LLVM Programming Documentation</a></li>
22 <li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
23 <li><a href="#maillist">LLVM Mailing Lists</a></li>
25 </td><td class="right">
26 <form action="http://www.google.com/search" method=get>
28 <input type="hidden" name="sitesearch" value="llvm.org/docs">
29 <input type=text name=q size=25><br>
30 <input type=submit value="Search the LLVM Docs" name="submit">
35 <div class="doc_author">
36 <p>Written by <a href="http://llvm.org/">The LLVM Team</a></p>
39 <!--=======================================================================-->
40 <h2><a name="llvmdesign">LLVM Design & Overview</a></h2>
41 <!--=======================================================================-->
44 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
45 intermediate representation.</li>
46 <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>
47 <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>
48 <li><a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
49 Lifelong Program Analysis & Transformation</a> - Design overview.</li>
50 <li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
51 Multi-Stage Optimization</a> - More details (quite old now).</li>
52 <li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
53 frequent questions about LLVM's most frequently misunderstood instruction.</li>
56 <!--=======================================================================-->
57 <h2><a name="userguide">LLVM User Guides</a></h2>
58 <!--=======================================================================-->
61 <li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
62 Discusses how to get up and running quickly with the LLVM infrastructure.
63 Everything from unpacking and compilation of the distribution to execution of
66 <li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
67 Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
68 those using Visual Studio on Windows.</li>
70 <li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
71 LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
72 <li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
73 policy towards developers and their contributions.</li>
75 <li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
76 manual for the LLVM command line utilities ("man" pages for LLVM tools).<br>
78 <a href="/cmds/llvm-ar.html">llvm-ar</a>,
79 <a href="/cmds/llvm-as.html">llvm-as</a>,
80 <a href="/cmds/llvm-dis.html">llvm-dis</a>,
81 <a href="/cmds/llvm-extract.html">llvm-extract</a>,
82 <a href="/cmds/llvm-ld.html">llvm-ld</a>,
83 <a href="/cmds/llvm-link.html">llvm-link</a>,
84 <a href="/cmds/llvm-nm.html">llvm-nm</a>,
85 <a href="/cmds/llvm-prof.html">llvm-prof</a>,
86 <a href="/cmds/llvm-ranlib.html">llvm-ranlib</a>,
87 <a href="/cmds/opt.html">opt</a>,
88 <a href="/cmds/llc.html">llc</a>,
89 <a href="/cmds/lli.html">lli</a>,
90 <a href="/cmds/llvmgcc.html">llvm-gcc</a>,
91 <a href="/cmds/llvmgxx.html">llvm-g++</a>,
92 <a href="/cmds/bugpoint.html">bugpoint</a>,
93 <a href="/cmds/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
96 <li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of
97 optimizations and analyses implemented in LLVM.</li>
99 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
100 questions and problems and their solutions.</li>
102 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
103 - This describes new features, known bugs, and other limitations.</li>
105 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
106 Instructions for properly submitting information about any bugs you run into in
107 the LLVM system.</li>
109 <li><a href="TestingGuide.html">LLVM Testing Infrastructure Guide</a> - A reference
110 manual for using the LLVM testing infrastructure.</li>
112 <li><a href="GCCFEBuildInstrs.html">How to build the Ada/C/C++/Fortran front-ends</a> -
113 Instructions for building gcc front-ends from source.</li>
115 <li><a href="Packaging.html">Packaging guide</a> - Advice on packaging
116 LLVM into a distribution.</li>
118 <li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
119 and concepts used in LLVM.</li>
121 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
122 channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
123 using the mozilla browser, and have chatzilla installed, you can <a
124 href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
129 <!--=======================================================================-->
130 <h2><a name="llvmprog">General LLVM Programming Documentation</a></h2>
131 <!--=======================================================================-->
134 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
135 intermediate representation and the assembly form of the different nodes.</li>
137 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
138 Introduction to the general layout of the LLVM sourcebase, important classes
139 and APIs, and some tips & tricks.</li>
141 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
142 templates for new projects that <em>use</em> the LLVM infrastructure. The
143 templates (directory organization, Makefiles, and test tree) allow the project
144 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
145 header files and libraries.</li>
147 <li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
148 LLVM makefiles work and how to use them.</li>
150 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
151 Provides information on using the command line parsing library.</li>
153 <li><a href="CodingStandards.html">LLVM Coding standards</a> -
154 Details the LLVM coding standards and provides useful information on writing
155 efficient C++ code.</li>
157 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
158 to add instructions and intrinsics to LLVM.</li>
160 <li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
161 understand how to use the libraries produced when LLVM is compiled.</li>
163 <li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
164 is a guide to preparing LLVM releases. Most developers can ignore it.</li>
167 <li><a href="http://llvm.org/doxygen/">Doxygen generated
168 documentation</a> (<a
169 href="http://llvm.org/doxygen/inherits.html">classes</a>)
171 (<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
174 <li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
178 <!--=======================================================================-->
179 <h2><a name="subsystems">LLVM Subsystem Documentation</a></h2>
180 <!--=======================================================================-->
184 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
185 on how to write LLVM transformations and analyses.</li>
187 <li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
188 on how to write LLVM backends for machine targets.</li>
190 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
191 Generator</a> - The design and implementation of the LLVM code generator.
192 Useful if you are working on retargetting LLVM to a new architecture, designing
193 a new codegen pass, or enhancing existing components.</li>
195 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
196 Describes the TableGen tool, which is used heavily by the LLVM code
199 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
200 on how to write a new alias analysis implementation or how to use existing
203 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
204 LLVM</a> - The interfaces source-language compilers should use for compiling
207 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
208 LLVM</a> - This document describes the design and philosophy behind the LLVM
209 source-level debugger.</li>
211 <li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
212 - This document describes the design and implementation of exception handling
215 <li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
216 reducer description and usage information.</li>
218 <li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a> - This describes
219 the file format and encoding used for LLVM "bc" files.</li>
221 <li><a href="SystemLibrary.html">System Library</a> - This document describes
222 the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
225 <li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
226 document describes the interface between LLVM intermodular optimizer and
227 the linker and its design</li>
229 <li><a href="GoldPlugin.html">The LLVM gold plugin</a> - How to build your
230 programs with link-time optimization on Linux.</li>
232 <li><a href="DebuggingJITedCode.html">The GDB JIT interface</a> - How to debug
233 JITed code with GDB.</li>
235 <li><a href="BranchWeightMetadata.html">Branch Weight Metadata</a> - Provides
236 information about Branch Prediction Information.</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$