Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / f193ffa7db56fd38b9d15d762b3e1dda223dda14 / . / docs / index.html
blob: 0a50c3c367d9e40d73d91b6c7961dc21ab048123 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <title>Documentation for the LLVM System</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
7</head>
8<body>
9
10<div class="doc_title">Documentation for the LLVM System</div>
11
12<div class="doc_text">
13<table class="layout" width="95%"><tr class="layout"><td class="left">
14<ul>
15 <li><a href="#llvmdesign">LLVM Design</a></li>
16 <li><a href="/pubs/">LLVM Publications</a></li>
17 <li><a href="#userguide">LLVM User Guides</a></li>
18 <li><a href="#llvmprog">General LLVM Programming Documentation</a></li>
19 <li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
20 <li><a href="#maillist">LLVM Mailing Lists</a></li>
21</ul>
22</td><td class="right">
23 <form action="http://www.google.com/search" method=get>
Misha Brukman4fbc44d2008-12-11 18:14:06 +0000[diff] [blame]24 <p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]25 <input type="hidden" name="sitesearch" value="llvm.org/docs">
26 <input type=text name=q size=25><br>
27 <input type=submit value="Search the LLVM Docs" name="submit">
Misha Brukman4fbc44d2008-12-11 18:14:06 +0000[diff] [blame]28 </p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]29 </form>
30</td></tr></table>
31</div>
32
33<div class="doc_author">
34 <p>Written by <a href="http://llvm.org">The LLVM Team</a></p>
35</div>
36
37<!--=======================================================================-->
38<div class="doc_section"><a name="llvmdesign">LLVM Design &amp; Overview</a></div>
39<!--=======================================================================-->
40
41<ul>
42<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
43intermediate representation.</li>
44<li><a href="http://llvm.org/pubs/2006-04-25-GelatoLLVMIntro.html">Introduction to the LLVM Compiler Infrastructure</a> - Presentation describing LLVM.</li>
45<li><a href="http://llvm.org/pubs/2004-09-22-LCPCLLVMTutorial.html">The LLVM Compiler Framework and
46Infrastructure Tutorial</a> - Tutorial for writing passes, exploring the system.</li>
47<li><a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
48Lifelong Program Analysis &amp; Transformation</a> - Design overview.</li>
49<li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
50Multi-Stage Optimization</a> - More details (somewhat old now).</li>
51<li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
52frequent questions about LLVM's most frequently misunderstood instruction.</li>
53</ul>
54
55<!--=======================================================================-->
56<div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
57<!--=======================================================================-->
58
59<ul>
60<li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
61Discusses how to get up and running quickly with the LLVM infrastructure.
62Everything from unpacking and compilation of the distribution to execution of
63some tools.</li>
64
65<li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
66Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
67those using Visual Studio on Windows.</li>
68
Chris Lattnerb7da3a12007-11-09 19:24:54 +0000[diff] [blame]69<li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
Nick Lewycky345de762007-11-09 05:45:51 +0000[diff] [blame]70LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]71<li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
72policy towards developers and their contributions.</li>
73
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]74<li><a href="/docs/CommandGuide/index.html">LLVM Command Guide</a> - A reference
Misha Brukman4fbc44d2008-12-11 18:14:06 +0000[diff] [blame]75manual for the LLVM command line utilities ("man" pages for LLVM tools).<br>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]76Current tools:
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]77 <a href="/cmds/llvm-ar.html">llvm-ar</a>,
78 <a href="/cmds/llvm-as.html">llvm-as</a>,
79 <a href="/cmds/llvm-dis.html">llvm-dis</a>,
80 <a href="/cmds/llvm-extract.html">llvm-extract</a>,
81 <a href="/cmds/llvm-ld.html">llvm-ld</a>,
82 <a href="/cmds/llvm-link.html">llvm-link</a>,
83 <a href="/cmds/llvm-nm.html">llvm-nm</a>,
84 <a href="/cmds/llvm-prof.html">llvm-prof</a>,
85 <a href="/cmds/llvm-ranlib.html">llvm-ranlib</a>,
86 <a href="/cmds/opt.html">opt</a>,
87 <a href="/cmds/llc.html">llc</a>,
88 <a href="/cmds/lli.html">lli</a>,
89 <a href="/cmds/llvmc.html">llvmc</a>
90 <a href="/cmds/llvmgcc.html">llvm-gcc</a>,
91 <a href="/cmds/llvmgxx.html">llvm-g++</a>,
92 <a href="/cmds/stkrc.html">stkrc</a>,
93 <a href="/cmds/bugpoint.html">bugpoint</a>,
94 <a href="/cmds/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]95</li>
96
Tanya Lattner79e6c772008-03-24 18:29:32 +0000[diff] [blame]97<li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of
98optimizations and analyses implemented in LLVM.</li>
99
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]100<li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
101questions and problems and their solutions.</li>
102
103<li><a href="ReleaseNotes.html">Release notes for the current release</a>
104- This describes new features, known bugs, and other limitations.</li>
105
106<li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
107Instructions for properly submitting information about any bugs you run into in
108the LLVM system.</li>
109
Matthijs Kooijmaneb69e792008-07-02 13:54:58 +0000[diff] [blame]110<li><a href="TestingGuide.html">LLVM Testing Infrastructure Guide</a> - A reference
111manual for using the LLVM testing infrastructure.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]112
Duncan Sands7dbf8132008-12-10 10:50:58 +0000[diff] [blame]113<li><a href="GCCFEBuildInstrs.html">How to build the Ada/C/C++/Fortran front-ends</a> -
114Instructions for building gcc front-ends from source.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]115
116<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
117and concepts used in LLVM.</li>
118
119<li><a name="irc">You can probably find help on the unofficial LLVM IRC
120channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
121using the mozilla browser, and have chatzilla installed, you can <a
122href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
123
124</ul>
125
126
127<!--=======================================================================-->
128<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
129<!--=======================================================================-->
130
131<ul>
132<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
133intermediate representation and the assembly form of the different nodes.</li>
134
135<li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
136Introduction to the general layout of the LLVM sourcebase, important classes
137and APIs, and some tips &amp; tricks.</li>
138
139<li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
140templates for new projects that <em>use</em> the LLVM infrastructure. The
141templates (directory organization, Makefiles, and test tree) allow the project
142code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
143header files and libraries.</li>
144
145<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
146LLVM makefiles work and how to use them.</li>
147
148<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
149Provides information on using the command line parsing library.</li>
150
151<li><a href="CodingStandards.html">LLVM Coding standards</a> -
152Details the LLVM coding standards and provides useful information on writing
153efficient C++ code.</li>
154
155<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
156to add instructions and intrinsics to LLVM.</li>
157
158<li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
159understand how to use the libraries produced when LLVM is compiled.</li>
160
161<li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
162is a guide to preparing LLVM releases. Most developers can ignore it.</li>
163
164<li><a href="http://llvm.org/doxygen/">Doxygen generated
165documentation</a> (<a
166href="http://llvm.org/doxygen/inherits.html">classes</a>)
167
168(<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
169</li>
170
171<li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
172
173</ul>
174
175<!--=======================================================================-->
176<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
177<!--=======================================================================-->
178
179<ul>
180
181<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
182on how to write LLVM transformations and analyses.</li>
183
184<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
185on how to write LLVM backends for machine targets.</li>
186
187<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
188Generator</a> - The design and implementation of the LLVM code generator.
189Useful if you are working on retargetting LLVM to a new architecture, designing
190a new codegen pass, or enhancing existing components.</li>
191
192<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
193Describes the TableGen tool, which is used heavily by the LLVM code
194generator.</li>
195
196<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
197on how to write a new alias analysis implementation or how to use existing
198analyses.</li>
199
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]200<li><a href="GarbageCollection.html">Accurate Garbage Collection with
201LLVM</a> - The interfaces source-language compilers should use for compiling
202GC'd programs.</li>
203
204<li><a href="SourceLevelDebugging.html">Source Level Debugging with
205LLVM</a> - This document describes the design and philosophy behind the LLVM
206source-level debugger.</li>
207
208<li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
209- This document describes the design and implementation of exception handling
210in LLVM.</li>
211
212<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
213reducer description and usage information.</li>
214
215<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
216describes the design and configuration of the LLVM compiler driver tool,
217<tt>llvmc</tt>.</li>
218
Chris Lattner6b118e12008-07-13 21:27:36 +0000[diff] [blame]219<li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a> - This describes
220the file format and encoding used for LLVM "bc" files.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]221
222<li><a href="SystemLibrary.html">System Library</a> - This document describes
223the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
224portable</li>
225
226<li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
227document describes the interface between LLVM intermodular optimizer and
228the linker and its design</li>
229
230</ul>
231
232
233<!--=======================================================================-->
234<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
235<!--=======================================================================-->
236
237<ul>
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]238<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]239LLVM Announcements List</a>: This is a low volume list that provides important
240announcements regarding LLVM. It gets email about once a month.</li>
241
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]242<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]243List</a>: This list is for people who want to be included in technical
244discussions of LLVM. People post to this list when they have questions about
245writing code for or using the LLVM tools. It is relatively low volume.</li>
246
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]247<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]248Patches Archive</a>: This list gets emailed every time a bug is opened and
249closed, and when people submit patches to be included in LLVM. It is higher
250volume than the LLVMdev list.</li>
251
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]252<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/">Commits
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]253Archive</a>: This list contains all commit messages that are made when LLVM
254developers commit code changes to the repository. It is useful for those who
255want to stay on the bleeding edge of LLVM development. This list is very high
256volume.</li>
257
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]258<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]259Test Results Archive</a>: A message is automatically sent to this list by every
260active nightly tester when it completes. As such, this list gets email several
261times each day, making it a high volume list.</li>
262
263</ul>
264
265<!-- *********************************************************************** -->
266
267<hr>
268<address>
269 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame]270 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]271 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame]272 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]273
274 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
275 Last modified: $Date$
276</address>
277</body></html>
Chris Lattner38bd5dd2007-09-21 17:30:40 +0000[diff] [blame]278