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